├── .editorconfig ├── .gitignore ├── .node-version ├── .nvmrc ├── .vscode └── settings.json ├── LICENSE ├── README.md ├── circle.yml ├── docs ├── README.md ├── classes │ ├── _api_advancedsecurity_.onvifadvancedsecurity.md │ ├── _api_analytics_.onvifanalytics.md │ ├── _api_device_.onvifdevice.md │ ├── _api_display_.onvifdisplay.md │ ├── _api_event_.onvifevent.md │ ├── _api_imaging_.onvifimaging.md │ ├── _api_index_.managedonvifapi.md │ ├── _api_media_.onvifmedia.md │ ├── _api_provisioning_.onvifprovisioning.md │ ├── _api_ptz_.onvifptz.md │ ├── _api_receiver_.onvifreceiver.md │ ├── _api_recording_.onvifrecording.md │ ├── _api_replay_.onvifreplay.md │ └── _api_search_.onvifsearch.md ├── enums │ ├── _api_types_.afmodes.md │ ├── _api_types_.audioclasstype.md │ ├── _api_types_.audioencoding.md │ ├── _api_types_.audioencodingmimenames.md │ ├── _api_types_.autofocusmode.md │ ├── _api_types_.autogeomodes.md │ ├── _api_types_.backlightcompensationmode.md │ ├── _api_types_.capabilitycategory.md │ ├── _api_types_.connectionstatus.md │ ├── _api_types_.defoggingmode.md │ ├── _api_types_.digitalidlestate.md │ ├── _api_types_.direction.md │ ├── _api_types_.discoverymode.md │ ├── _api_types_.dot11authandmangementsuite.md │ ├── _api_types_.dot11cipher.md │ ├── _api_types_.dot11securitymode.md │ ├── _api_types_.dot11signalstrength.md │ ├── _api_types_.dot11stationmode.md │ ├── _api_types_.duplex.md │ ├── _api_types_.dynamicdnstype.md │ ├── _api_types_.eflipmode.md │ ├── _api_types_.enabled.md │ ├── _api_types_.entity.md │ ├── _api_types_.eventbrokerprotocol.md │ ├── _api_types_.exposuremode.md │ ├── _api_types_.exposurepriority.md │ ├── _api_types_.factorydefaulttype.md │ ├── _api_types_.h264profile.md │ ├── _api_types_.imagesendingtype.md │ ├── _api_types_.imagestabilizationmode.md │ ├── _api_types_.ipaddressfiltertype.md │ ├── _api_types_.iptype.md │ ├── _api_types_.ipv6dhcpconfiguration.md │ ├── _api_types_.ircutfilterautoboundarytype.md │ ├── _api_types_.ircutfiltermode.md │ ├── _api_types_.metadatacompressiontype.md │ ├── _api_types_.modeofoperation.md │ ├── _api_types_.moveandtrackmethod.md │ ├── _api_types_.movestatus.md │ ├── _api_types_.mpeg4profile.md │ ├── _api_types_.networkhosttype.md │ ├── _api_types_.networkprotocoltype.md │ ├── _api_types_.osdtype.md │ ├── _api_types_.propertyoperation.md │ ├── _api_types_.ptzpresettourdirection.md │ ├── _api_types_.ptzpresettouroperation.md │ ├── _api_types_.ptzpresettourstate.md │ ├── _api_types_.receivermode.md │ ├── _api_types_.receiverstate.md │ ├── _api_types_.recordingstatus.md │ ├── _api_types_.relayidlestate.md │ ├── _api_types_.relaylogicalstate.md │ ├── _api_types_.relaymode.md │ ├── _api_types_.reversemode.md │ ├── _api_types_.rotatemode.md │ ├── _api_types_.sceneorientationmode.md │ ├── _api_types_.sceneorientationoption.md │ ├── _api_types_.scopedefinition.md │ ├── _api_types_.searchstate.md │ ├── _api_types_.setdatetimetype.md │ ├── _api_types_.storagetype.md │ ├── _api_types_.streamtype.md │ ├── _api_types_.systemlogtype.md │ ├── _api_types_.tonecompensationmode.md │ ├── _api_types_.tracktype.md │ ├── _api_types_.transportprotocol.md │ ├── _api_types_.userlevel.md │ ├── _api_types_.videoencoding.md │ ├── _api_types_.videoencodingmimenames.md │ ├── _api_types_.videoencodingprofiles.md │ ├── _api_types_.viewmodes.md │ ├── _api_types_.whitebalancemode.md │ ├── _api_types_.widedynamicmode.md │ ├── _soap_request_.soap_node.md │ └── _soap_request_.xmlns.md ├── interfaces │ ├── _api_types_.aacdecoptions.md │ ├── _api_types_.absolutefocus.md │ ├── _api_types_.absolutefocusoptions.md │ ├── _api_types_.actionengineeventpayload.md │ ├── _api_types_.actionengineeventpayloadextension.md │ ├── _api_types_.activeconnection.md │ ├── _api_types_.analyticscapabilities.md │ ├── _api_types_.analyticsdevicecapabilities.md │ ├── _api_types_.analyticsdeviceengineconfiguration.md │ ├── _api_types_.analyticsdeviceengineconfigurationextension.md │ ├── _api_types_.analyticsdeviceextension.md │ ├── _api_types_.analyticsengine.md │ ├── _api_types_.analyticsengineconfiguration.md │ ├── _api_types_.analyticsengineconfigurationextension.md │ ├── _api_types_.analyticsenginecontrol.md │ ├── _api_types_.analyticsengineinput.md │ ├── _api_types_.analyticsengineinputinfo.md │ ├── _api_types_.analyticsengineinputinfoextension.md │ ├── _api_types_.analyticsstate.md │ ├── _api_types_.analyticsstateinformation.md │ ├── _api_types_.anyholder.md │ ├── _api_types_.arrayoffileprogress.md │ ├── _api_types_.arrayoffileprogressextension.md │ ├── _api_types_.attachmentdata.md │ ├── _api_types_.audioattributes.md │ ├── _api_types_.audioclasscandidate.md │ ├── _api_types_.audioclassdescriptor.md │ ├── _api_types_.audioclassdescriptorextension.md │ ├── _api_types_.audiodecoderconfiguration.md │ ├── _api_types_.audiodecoderconfigurationoptions.md │ ├── _api_types_.audiodecoderconfigurationoptionsextension.md │ ├── _api_types_.audioencoder2configuration.md │ ├── _api_types_.audioencoder2configurationoptions.md │ ├── _api_types_.audioencoderconfiguration.md │ ├── _api_types_.audioencoderconfigurationoption.md │ ├── _api_types_.audioencoderconfigurationoptions.md │ ├── _api_types_.audiooutput.md │ ├── _api_types_.audiooutputconfiguration.md │ ├── _api_types_.audiooutputconfigurationoptions.md │ ├── _api_types_.audiosource.md │ ├── _api_types_.audiosourceconfiguration.md │ ├── _api_types_.audiosourceconfigurationoptions.md │ ├── _api_types_.audiosourceoptionsextension.md │ ├── _api_types_.backlightcompensation.md │ ├── _api_types_.backlightcompensation20.md │ ├── _api_types_.backlightcompensationoptions.md │ ├── _api_types_.backlightcompensationoptions20.md │ ├── _api_types_.backupfile.md │ ├── _api_types_.binarydata.md │ ├── _api_types_.body.md │ ├── _api_types_.capabilities.md │ ├── _api_types_.capabilitiesextension.md │ ├── _api_types_.capabilitiesextension2.md │ ├── _api_types_.celllayout.md │ ├── _api_types_.certificate.md │ ├── _api_types_.certificategenerationparameters.md │ ├── _api_types_.certificategenerationparametersextension.md │ ├── _api_types_.certificateinformation.md │ ├── _api_types_.certificateinformationextension.md │ ├── _api_types_.certificatestatus.md │ ├── _api_types_.certificateusage.md │ ├── _api_types_.certificatewithprivatekey.md │ ├── _api_types_.codingcapabilities.md │ ├── _api_types_.color.md │ ├── _api_types_.colorcovariance.md │ ├── _api_types_.colordescriptor.md │ ├── _api_types_.coloroptions.md │ ├── _api_types_.colorspacerange.md │ ├── _api_types_.config.md │ ├── _api_types_.configdescription.md │ ├── _api_types_.configdescriptionextension.md │ ├── _api_types_.configurationentity.md │ ├── _api_types_.continuousfocus.md │ ├── _api_types_.continuousfocusoptions.md │ ├── _api_types_.date.md │ ├── _api_types_.datetime.md │ ├── _api_types_.datetimerange.md │ ├── _api_types_.defogging.md │ ├── _api_types_.defoggingextension.md │ ├── _api_types_.defoggingoptions.md │ ├── _api_types_.detail.md │ ├── _api_types_.devicecapabilities.md │ ├── _api_types_.devicecapabilitiesextension.md │ ├── _api_types_.deviceentity.md │ ├── _api_types_.deviceiocapabilities.md │ ├── _api_types_.deviceservicecapabilities.md │ ├── _api_types_.digitalinput.md │ ├── _api_types_.displaycapabilities.md │ ├── _api_types_.dnsinformation.md │ ├── _api_types_.dnsinformationextension.md │ ├── _api_types_.dot11availablenetworks.md │ ├── _api_types_.dot11availablenetworksextension.md │ ├── _api_types_.dot11capabilities.md │ ├── _api_types_.dot11configuration.md │ ├── _api_types_.dot11pskset.md │ ├── _api_types_.dot11psksetextension.md │ ├── _api_types_.dot11securityconfiguration.md │ ├── _api_types_.dot11securityconfigurationextension.md │ ├── _api_types_.dot11status.md │ ├── _api_types_.dot1xconfiguration.md │ ├── _api_types_.dot1xconfigurationextension.md │ ├── _api_types_.dot3configuration.md │ ├── _api_types_.durationrange.md │ ├── _api_types_.dynamicdnsinformation.md │ ├── _api_types_.dynamicdnsinformationextension.md │ ├── _api_types_.eapmethodconfiguration.md │ ├── _api_types_.eapmethodextension.md │ ├── _api_types_.eflip.md │ ├── _api_types_.eflipoptions.md │ ├── _api_types_.eflipoptionsextension.md │ ├── _api_types_.engineconfiguration.md │ ├── _api_types_.envelope.md │ ├── _api_types_.eventbrokerconfig.md │ ├── _api_types_.eventcapabilities.md │ ├── _api_types_.eventfilter.md │ ├── _api_types_.eventsubscription.md │ ├── _api_types_.exposure.md │ ├── _api_types_.exposure20.md │ ├── _api_types_.exposureoptions.md │ ├── _api_types_.exposureoptions20.md │ ├── _api_types_.fault.md │ ├── _api_types_.fileprogress.md │ ├── _api_types_.filtertype.md │ ├── _api_types_.findeventresult.md │ ├── _api_types_.findeventresultlist.md │ ├── _api_types_.findmetadataresult.md │ ├── _api_types_.findmetadataresultlist.md │ ├── _api_types_.findptzpositionresult.md │ ├── _api_types_.findptzpositionresultlist.md │ ├── _api_types_.findrecordingresultlist.md │ ├── _api_types_.floatitems.md │ ├── _api_types_.floatrange.md │ ├── _api_types_.focusconfiguration.md │ ├── _api_types_.focusconfiguration20.md │ ├── _api_types_.focusconfiguration20extension.md │ ├── _api_types_.focusmove.md │ ├── _api_types_.focusoptions.md │ ├── _api_types_.focusoptions20.md │ ├── _api_types_.focusoptions20extension.md │ ├── _api_types_.focusstatus.md │ ├── _api_types_.focusstatus20.md │ ├── _api_types_.focusstatus20extension.md │ ├── _api_types_.g711decoptions.md │ ├── _api_types_.g726decoptions.md │ ├── _api_types_.genericeappwdconfigurationextension.md │ ├── _api_types_.geolocation.md │ ├── _api_types_.geoorientation.md │ ├── _api_types_.getrecordingjobsresponseitem.md │ ├── _api_types_.getrecordingsresponseitem.md │ ├── _api_types_.gettracksresponseitem.md │ ├── _api_types_.gettracksresponselist.md │ ├── _api_types_.h264configuration.md │ ├── _api_types_.h264decoptions.md │ ├── _api_types_.h264options.md │ ├── _api_types_.h264options2.md │ ├── _api_types_.header.md │ ├── _api_types_.hostnameinformation.md │ ├── _api_types_.hostnameinformationextension.md │ ├── _api_types_.imagestabilization.md │ ├── _api_types_.imagestabilizationextension.md │ ├── _api_types_.imagestabilizationoptions.md │ ├── _api_types_.imagestabilizationoptionsextension.md │ ├── _api_types_.imagingcapabilities.md │ ├── _api_types_.imagingoptions.md │ ├── _api_types_.imagingoptions20.md │ ├── _api_types_.imagingoptions20extension.md │ ├── _api_types_.imagingoptions20extension2.md │ ├── _api_types_.imagingoptions20extension3.md │ ├── _api_types_.imagingoptions20extension4.md │ ├── _api_types_.imagingsettings.md │ ├── _api_types_.imagingsettings20.md │ ├── _api_types_.imagingsettingsextension.md │ ├── _api_types_.imagingsettingsextension20.md │ ├── _api_types_.imagingsettingsextension202.md │ ├── _api_types_.imagingsettingsextension203.md │ ├── _api_types_.imagingsettingsextension204.md │ ├── _api_types_.imagingstatus.md │ ├── _api_types_.imagingstatus20.md │ ├── _api_types_.imagingstatus20extension.md │ ├── _api_types_.intitems.md │ ├── _api_types_.intrange.md │ ├── _api_types_.intrectangle.md │ ├── _api_types_.intrectanglerange.md │ ├── _api_types_.invalidfilterfaulttype.md │ ├── _api_types_.invalidmessagecontentexpressionfaulttype.md │ ├── _api_types_.invalidproducerpropertiesexpressionfaulttype.md │ ├── _api_types_.invalidtopicexpressionfaulttype.md │ ├── _api_types_.iocapabilities.md │ ├── _api_types_.iocapabilitiesextension.md │ ├── _api_types_.iocapabilitiesextension2.md │ ├── _api_types_.ipaddress.md │ ├── _api_types_.ipaddressfilter.md │ ├── _api_types_.ipaddressfilterextension.md │ ├── _api_types_.ipv4configuration.md │ ├── _api_types_.ipv4networkinterface.md │ ├── _api_types_.ipv4networkinterfacesetconfiguration.md │ ├── _api_types_.ipv6configuration.md │ ├── _api_types_.ipv6configurationextension.md │ ├── _api_types_.ipv6networkinterface.md │ ├── _api_types_.ipv6networkinterfacesetconfiguration.md │ ├── _api_types_.ircutfilterautoadjustment.md │ ├── _api_types_.ircutfilterautoadjustmentextension.md │ ├── _api_types_.ircutfilterautoadjustmentoptions.md │ ├── _api_types_.ircutfilterautoadjustmentoptionsextension.md │ ├── _api_types_.itemlist.md │ ├── _api_types_.itemlistdescription.md │ ├── _api_types_.itemlistdescriptionextension.md │ ├── _api_types_.itemlistextension.md │ ├── _api_types_.jpegdecoptions.md │ ├── _api_types_.jpegoptions.md │ ├── _api_types_.jpegoptions2.md │ ├── _api_types_.layout.md │ ├── _api_types_.layoutextension.md │ ├── _api_types_.layoutoptions.md │ ├── _api_types_.layoutoptionsextension.md │ ├── _api_types_.lensdescription.md │ ├── _api_types_.lensoffset.md │ ├── _api_types_.lensprojection.md │ ├── _api_types_.locallocation.md │ ├── _api_types_.localorientation.md │ ├── _api_types_.locationentity.md │ ├── _api_types_.maximumnumberofosds.md │ ├── _api_types_.mediaattributes.md │ ├── _api_types_.mediacapabilities.md │ ├── _api_types_.mediacapabilitiesextension.md │ ├── _api_types_.mediauri.md │ ├── _api_types_.messagedescription.md │ ├── _api_types_.messagedescriptionextension.md │ ├── _api_types_.messageextension.md │ ├── _api_types_.metadataattributes.md │ ├── _api_types_.metadataconfiguration.md │ ├── _api_types_.metadataconfigurationextension.md │ ├── _api_types_.metadataconfigurationoptions.md │ ├── _api_types_.metadataconfigurationoptionsextension.md │ ├── _api_types_.metadataconfigurationoptionsextension2.md │ ├── _api_types_.metadatafilter.md │ ├── _api_types_.metadatainput.md │ ├── _api_types_.metadatainputextension.md │ ├── _api_types_.misccapabilities.md │ ├── _api_types_.motionexpression.md │ ├── _api_types_.motionexpressionconfiguration.md │ ├── _api_types_.moveoptions.md │ ├── _api_types_.moveoptions20.md │ ├── _api_types_.mpeg4configuration.md │ ├── _api_types_.mpeg4decoptions.md │ ├── _api_types_.mpeg4options.md │ ├── _api_types_.mpeg4options2.md │ ├── _api_types_.multicastconfiguration.md │ ├── _api_types_.multipletopicsspecifiedfaulttype.md │ ├── _api_types_.networkcapabilities.md │ ├── _api_types_.networkcapabilitiesextension.md │ ├── _api_types_.networkcapabilitiesextension2.md │ ├── _api_types_.networkgateway.md │ ├── _api_types_.networkhost.md │ ├── _api_types_.networkhostextension.md │ ├── _api_types_.networkinterface.md │ ├── _api_types_.networkinterfaceconnectionsetting.md │ ├── _api_types_.networkinterfaceextension.md │ ├── _api_types_.networkinterfaceextension2.md │ ├── _api_types_.networkinterfaceinfo.md │ ├── _api_types_.networkinterfacelink.md │ ├── _api_types_.networkinterfacesetconfiguration.md │ ├── _api_types_.networkinterfacesetconfigurationextension.md │ ├── _api_types_.networkinterfacesetconfigurationextension2.md │ ├── _api_types_.networkprotocol.md │ ├── _api_types_.networkprotocolextension.md │ ├── _api_types_.networkzeroconfiguration.md │ ├── _api_types_.networkzeroconfigurationextension.md │ ├── _api_types_.networkzeroconfigurationextension2.md │ ├── _api_types_.nocurrentmessageontopicfaulttype.md │ ├── _api_types_.noisereduction.md │ ├── _api_types_.noisereductionoptions.md │ ├── _api_types_.notificationmessageholdertype.md │ ├── _api_types_.notifymessagenotsupportedfaulttype.md │ ├── _api_types_.ntpinformation.md │ ├── _api_types_.ntpinformationextension.md │ ├── _api_types_.onvifversion.md │ ├── _api_types_.osdcolor.md │ ├── _api_types_.osdcoloroptions.md │ ├── _api_types_.osdcoloroptionsextension.md │ ├── _api_types_.osdconfiguration.md │ ├── _api_types_.osdconfigurationextension.md │ ├── _api_types_.osdconfigurationoptions.md │ ├── _api_types_.osdconfigurationoptionsextension.md │ ├── _api_types_.osdimgconfiguration.md │ ├── _api_types_.osdimgconfigurationextension.md │ ├── _api_types_.osdimgoptions.md │ ├── _api_types_.osdimgoptionsextension.md │ ├── _api_types_.osdposconfiguration.md │ ├── _api_types_.osdposconfigurationextension.md │ ├── _api_types_.osdreference.md │ ├── _api_types_.osdtextconfiguration.md │ ├── _api_types_.osdtextconfigurationextension.md │ ├── _api_types_.osdtextoptions.md │ ├── _api_types_.osdtextoptionsextension.md │ ├── _api_types_.paneconfiguration.md │ ├── _api_types_.panelayout.md │ ├── _api_types_.panelayoutoptions.md │ ├── _api_types_.paneoptionextension.md │ ├── _api_types_.pantiltlimits.md │ ├── _api_types_.pausefailedfaulttype.md │ ├── _api_types_.polygon.md │ ├── _api_types_.polygonoptions.md │ ├── _api_types_.polyline.md │ ├── _api_types_.polylinearray.md │ ├── _api_types_.polylinearrayconfiguration.md │ ├── _api_types_.polylinearrayextension.md │ ├── _api_types_.prefixedipv4address.md │ ├── _api_types_.prefixedipv6address.md │ ├── _api_types_.presettour.md │ ├── _api_types_.profile.md │ ├── _api_types_.profilecapabilities.md │ ├── _api_types_.profileextension.md │ ├── _api_types_.profileextension2.md │ ├── _api_types_.profilestatus.md │ ├── _api_types_.profilestatusextension.md │ ├── _api_types_.ptcontroldirection.md │ ├── _api_types_.ptcontroldirectionextension.md │ ├── _api_types_.ptcontroldirectionoptions.md │ ├── _api_types_.ptcontroldirectionoptionsextension.md │ ├── _api_types_.ptzcapabilities.md │ ├── _api_types_.ptzconfiguration.md │ ├── _api_types_.ptzconfigurationextension.md │ ├── _api_types_.ptzconfigurationextension2.md │ ├── _api_types_.ptzconfigurationoptions.md │ ├── _api_types_.ptzconfigurationoptions2.md │ ├── _api_types_.ptzfilter.md │ ├── _api_types_.ptzmovestatus.md │ ├── _api_types_.ptznode.md │ ├── _api_types_.ptznodeextension.md │ ├── _api_types_.ptznodeextension2.md │ ├── _api_types_.ptzpositionfilter.md │ ├── _api_types_.ptzpreset.md │ ├── _api_types_.ptzpresettourextension.md │ ├── _api_types_.ptzpresettouroptions.md │ ├── _api_types_.ptzpresettourpresetdetail.md │ ├── _api_types_.ptzpresettourpresetdetailoptions.md │ ├── _api_types_.ptzpresettourpresetdetailoptionsextension.md │ ├── _api_types_.ptzpresettourspot.md │ ├── _api_types_.ptzpresettourspotextension.md │ ├── _api_types_.ptzpresettourspotoptions.md │ ├── _api_types_.ptzpresettourstartingcondition.md │ ├── _api_types_.ptzpresettourstartingconditionextension.md │ ├── _api_types_.ptzpresettourstartingconditionoptions.md │ ├── _api_types_.ptzpresettourstartingconditionoptionsextension.md │ ├── _api_types_.ptzpresettourstatus.md │ ├── _api_types_.ptzpresettourstatusextension.md │ ├── _api_types_.ptzpresettoursupported.md │ ├── _api_types_.ptzpresettoursupportedextension.md │ ├── _api_types_.ptzpresettourtypeextension.md │ ├── _api_types_.ptzspaces.md │ ├── _api_types_.ptzspacesextension.md │ ├── _api_types_.ptzspeed.md │ ├── _api_types_.ptzstatus.md │ ├── _api_types_.ptzstatusfilteroptions.md │ ├── _api_types_.ptzstatusfilteroptionsextension.md │ ├── _api_types_.ptzvector.md │ ├── _api_types_.queryexpressiontype.md │ ├── _api_types_.realtimestreamingcapabilities.md │ ├── _api_types_.realtimestreamingcapabilitiesextension.md │ ├── _api_types_.receiver.md │ ├── _api_types_.receivercapabilities.md │ ├── _api_types_.receiverconfiguration.md │ ├── _api_types_.receiverstateinformation.md │ ├── _api_types_.recordingcapabilities.md │ ├── _api_types_.recordingconfiguration.md │ ├── _api_types_.recordinginformation.md │ ├── _api_types_.recordingjobconfiguration.md │ ├── _api_types_.recordingjobconfigurationextension.md │ ├── _api_types_.recordingjobsource.md │ ├── _api_types_.recordingjobsourceextension.md │ ├── _api_types_.recordingjobstateinformation.md │ ├── _api_types_.recordingjobstateinformationextension.md │ ├── _api_types_.recordingjobstatesource.md │ ├── _api_types_.recordingjobstatetrack.md │ ├── _api_types_.recordingjobstatetracks.md │ ├── _api_types_.recordingjobtrack.md │ ├── _api_types_.recordingsourceinformation.md │ ├── _api_types_.recordingsummary.md │ ├── _api_types_.rectangle.md │ ├── _api_types_.relativefocus.md │ ├── _api_types_.relativefocusoptions.md │ ├── _api_types_.relativefocusoptions20.md │ ├── _api_types_.relayoutput.md │ ├── _api_types_.relayoutputsettings.md │ ├── _api_types_.remoteuser.md │ ├── _api_types_.replaycapabilities.md │ ├── _api_types_.replayconfiguration.md │ ├── _api_types_.resumefailedfaulttype.md │ ├── _api_types_.reverse.md │ ├── _api_types_.reverseoptions.md │ ├── _api_types_.reverseoptionsextension.md │ ├── _api_types_.rotate.md │ ├── _api_types_.rotateextension.md │ ├── _api_types_.rotateoptions.md │ ├── _api_types_.rotateoptionsextension.md │ ├── _api_types_.ruleengineconfiguration.md │ ├── _api_types_.ruleengineconfigurationextension.md │ ├── _api_types_.sceneorientation.md │ ├── _api_types_.scope.md │ ├── _api_types_.searchcapabilities.md │ ├── _api_types_.searchscope.md │ ├── _api_types_.searchscopeextension.md │ ├── _api_types_.securitycapabilities.md │ ├── _api_types_.securitycapabilitiesextension.md │ ├── _api_types_.securitycapabilitiesextension2.md │ ├── _api_types_.service.md │ ├── _api_types_.sourceidentification.md │ ├── _api_types_.sourceidentificationextension.md │ ├── _api_types_.sourcereference.md │ ├── _api_types_.space1ddescription.md │ ├── _api_types_.space2ddescription.md │ ├── _api_types_.storageconfiguration.md │ ├── _api_types_.storageconfigurationdata.md │ ├── _api_types_.storagereferencepath.md │ ├── _api_types_.storagereferencepathextension.md │ ├── _api_types_.streamsetup.md │ ├── _api_types_.subscribecreationfailedfaulttype.md │ ├── _api_types_.subscriptionpolicytype.md │ ├── _api_types_.supportedanalyticsmodules.md │ ├── _api_types_.supportedanalyticsmodulesextension.md │ ├── _api_types_.supportedrules.md │ ├── _api_types_.supportedrulesextension.md │ ├── _api_types_.supportinformation.md │ ├── _api_types_.systemcapabilities.md │ ├── _api_types_.systemcapabilitiesextension.md │ ├── _api_types_.systemcapabilitiesextension2.md │ ├── _api_types_.systemdatetime.md │ ├── _api_types_.systemdatetimeextension.md │ ├── _api_types_.systemlog.md │ ├── _api_types_.systemloguri.md │ ├── _api_types_.systemlogurilist.md │ ├── _api_types_.time.md │ ├── _api_types_.timezone.md │ ├── _api_types_.tlsconfiguration.md │ ├── _api_types_.tonecompensation.md │ ├── _api_types_.tonecompensationextension.md │ ├── _api_types_.tonecompensationoptions.md │ ├── _api_types_.topicexpressiondialectunknownfaulttype.md │ ├── _api_types_.topicexpressiontype.md │ ├── _api_types_.topicnotsupportedfaulttype.md │ ├── _api_types_.trackattributes.md │ ├── _api_types_.trackattributesextension.md │ ├── _api_types_.trackconfiguration.md │ ├── _api_types_.trackinformation.md │ ├── _api_types_.transformation.md │ ├── _api_types_.transformationextension.md │ ├── _api_types_.transport.md │ ├── _api_types_.unabletocreatepullpointfaulttype.md │ ├── _api_types_.unabletodestroypullpointfaulttype.md │ ├── _api_types_.unabletodestroysubscriptionfaulttype.md │ ├── _api_types_.unabletogetmessagesfaulttype.md │ ├── _api_types_.unacceptableinitialterminationtimefaulttype.md │ ├── _api_types_.unacceptableterminationtimefaulttype.md │ ├── _api_types_.unrecognizedpolicyrequestfaulttype.md │ ├── _api_types_.unsupportedpolicyrequestfaulttype.md │ ├── _api_types_.user.md │ ├── _api_types_.usercredential.md │ ├── _api_types_.userextension.md │ ├── _api_types_.vector.md │ ├── _api_types_.vector1d.md │ ├── _api_types_.vector2d.md │ ├── _api_types_.videoanalyticsconfiguration.md │ ├── _api_types_.videoattributes.md │ ├── _api_types_.videodecoderconfigurationoptions.md │ ├── _api_types_.videodecoderconfigurationoptionsextension.md │ ├── _api_types_.videoencoder2configuration.md │ ├── _api_types_.videoencoder2configurationoptions.md │ ├── _api_types_.videoencoderconfiguration.md │ ├── _api_types_.videoencoderconfigurationoptions.md │ ├── _api_types_.videoencoderoptionsextension.md │ ├── _api_types_.videoencoderoptionsextension2.md │ ├── _api_types_.videooutput.md │ ├── _api_types_.videooutputconfiguration.md │ ├── _api_types_.videooutputconfigurationoptions.md │ ├── _api_types_.videooutputextension.md │ ├── _api_types_.videoratecontrol.md │ ├── _api_types_.videoratecontrol2.md │ ├── _api_types_.videoresolution.md │ ├── _api_types_.videoresolution2.md │ ├── _api_types_.videosource.md │ ├── _api_types_.videosourceconfiguration.md │ ├── _api_types_.videosourceconfigurationextension.md │ ├── _api_types_.videosourceconfigurationextension2.md │ ├── _api_types_.videosourceconfigurationoptions.md │ ├── _api_types_.videosourceconfigurationoptionsextension.md │ ├── _api_types_.videosourceconfigurationoptionsextension2.md │ ├── _api_types_.videosourceextension.md │ ├── _api_types_.videosourceextension2.md │ ├── _api_types_.whitebalance.md │ ├── _api_types_.whitebalance20.md │ ├── _api_types_.whitebalance20extension.md │ ├── _api_types_.whitebalanceoptions.md │ ├── _api_types_.whitebalanceoptions20.md │ ├── _api_types_.whitebalanceoptions20extension.md │ ├── _api_types_.widedynamicrange.md │ ├── _api_types_.widedynamicrange20.md │ ├── _api_types_.widedynamicrangeoptions.md │ ├── _api_types_.widedynamicrangeoptions20.md │ ├── _api_types_.zoomlimits.md │ ├── _config_interfaces_.ideviceconfig.md │ ├── _config_interfaces_.isystemconfig.md │ ├── _config_interfaces_.itransportpayoad.md │ ├── _config_interfaces_.iusercredentials.md │ ├── _manage_device_.ideviceinitconfig.md │ ├── _manage_device_.imanageddevice.md │ ├── _soap_auth_.idigestbag.md │ ├── _soap_auth_.iusercredentials.md │ ├── _soap_request_.iresultstructure.md │ └── _soap_request_.ixmlcontainer.md └── modules │ ├── _api_advancedsecurity_.md │ ├── _api_analytics_.md │ ├── _api_device_.md │ ├── _api_display_.md │ ├── _api_event_.md │ ├── _api_imaging_.md │ ├── _api_index_.md │ ├── _api_media_.md │ ├── _api_provisioning_.md │ ├── _api_ptz_.md │ ├── _api_receiver_.md │ ├── _api_recording_.md │ ├── _api_replay_.md │ ├── _api_search_.md │ ├── _api_types_.md │ ├── _browser_.md │ ├── _config_browser_.md │ ├── _config_index_.md │ ├── _config_interfaces_.md │ ├── _config_node_.md │ ├── _config_universal_.md │ ├── _index_.md │ ├── _manage_device_.md │ ├── _manage_index_.md │ ├── _node_.md │ ├── _soap_auth_.md │ └── _soap_request_.md ├── package-lock.json ├── package.json ├── rollup.config.js ├── scripts ├── api │ ├── ast.ts │ ├── exec.ts │ ├── fetch-wsdl.ts │ ├── parse-onvif-wsdl.ts │ └── parse-onvif-xsd.ts ├── publish-prep.ts └── tsconfig.json ├── src ├── api │ ├── advancedsecurity.ts │ ├── analytics.ts │ ├── device.ts │ ├── display.ts │ ├── event.ts │ ├── imaging.ts │ ├── index.ts │ ├── media.ts │ ├── provisioning.ts │ ├── ptz.ts │ ├── receiver.ts │ ├── recording.ts │ ├── replay.ts │ ├── search.ts │ └── types.ts ├── browser.ts ├── config │ ├── browser.ts │ ├── index.ts │ ├── interfaces.ts │ ├── node.ts │ └── universal.ts ├── index.ts ├── manage │ ├── device.ts │ └── index.ts ├── node.ts └── soap │ ├── auth.ts │ └── request.ts ├── tsconfig.json ├── tsconfig.rollup.json └── tslint.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | 3 | root = true 4 | 5 | [*] 6 | charset = utf-8 7 | indent_style = space 8 | indent_size = 2 9 | end_of_line = lf 10 | insert_final_newline = true 11 | trim_trailing_whitespace = true 12 | 13 | [*.md] 14 | insert_final_newline = false 15 | trim_trailing_whitespace = false -------------------------------------------------------------------------------- /.node-version: -------------------------------------------------------------------------------- 1 | 16.10.0 -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 16.10.0 -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "editor.tabSize": 2, 3 | "typescript.tsdk": "node_modules/typescript/lib", 4 | "files.exclude": { 5 | ".rpt2_cache": true 6 | } 7 | } -------------------------------------------------------------------------------- /docs/enums/_api_types_.afmodes.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AFModes](_api_types_.afmodes.md) 2 | 3 | # Enumeration: AFModes 4 | 5 | Focus of a moving camera is updated only once after stopping a pan, tilt or zoom movement. 6 | 7 | ## Index 8 | 9 | ### Enumeration members 10 | 11 | * [OnceAfterMove](_api_types_.afmodes.md#onceaftermove) 12 | 13 | ## Enumeration members 14 | 15 | ### OnceAfterMove 16 | 17 | • **OnceAfterMove**: = "OnceAfterMove" 18 | 19 | *Defined in [api/types.ts:5399](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5399)* 20 | 21 | Focus of a moving camera is updated only once after stopping a pan, tilt or zoom movement. 22 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.audioencoding.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioEncoding](_api_types_.audioencoding.md) 2 | 3 | # Enumeration: AudioEncoding 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AAC](_api_types_.audioencoding.md#aac) 10 | * [G711](_api_types_.audioencoding.md#g711) 11 | * [G726](_api_types_.audioencoding.md#g726) 12 | 13 | ## Enumeration members 14 | 15 | ### AAC 16 | 17 | • **AAC**: = "AAC" 18 | 19 | *Defined in [api/types.ts:4753](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4753)* 20 | 21 | ___ 22 | 23 | ### G711 24 | 25 | • **G711**: = "G711" 26 | 27 | *Defined in [api/types.ts:4745](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4745)* 28 | 29 | ___ 30 | 31 | ### G726 32 | 33 | • **G726**: = "G726" 34 | 35 | *Defined in [api/types.ts:4749](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4749)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.autofocusmode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AutoFocusMode](_api_types_.autofocusmode.md) 2 | 3 | # Enumeration: AutoFocusMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AUTO](_api_types_.autofocusmode.md#auto) 10 | * [MANUAL](_api_types_.autofocusmode.md#manual) 11 | 12 | ## Enumeration members 13 | 14 | ### AUTO 15 | 16 | • **AUTO**: = "AUTO" 17 | 18 | *Defined in [api/types.ts:5385](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5385)* 19 | 20 | ___ 21 | 22 | ### MANUAL 23 | 24 | • **MANUAL**: = "MANUAL" 25 | 26 | *Defined in [api/types.ts:5389](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5389)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.backlightcompensationmode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [BacklightCompensationMode](_api_types_.backlightcompensationmode.md) 2 | 3 | # Enumeration: BacklightCompensationMode 4 | 5 | Enumeration describing the available backlight compenstation modes. 6 | 7 | ## Index 8 | 9 | ### Enumeration members 10 | 11 | * [OFF](_api_types_.backlightcompensationmode.md#off) 12 | * [ON](_api_types_.backlightcompensationmode.md#on) 13 | 14 | ## Enumeration members 15 | 16 | ### OFF 17 | 18 | • **OFF**: = "OFF" 19 | 20 | *Defined in [api/types.ts:5423](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5423)* 21 | 22 | Backlight compensation is disabled. 23 | 24 | ___ 25 | 26 | ### ON 27 | 28 | • **ON**: = "ON" 29 | 30 | *Defined in [api/types.ts:5427](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5427)* 31 | 32 | Backlight compensation is enabled. 33 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.defoggingmode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DefoggingMode](_api_types_.defoggingmode.md) 2 | 3 | # Enumeration: DefoggingMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AUTO](_api_types_.defoggingmode.md#auto) 10 | * [OFF](_api_types_.defoggingmode.md#off) 11 | * [ON](_api_types_.defoggingmode.md#on) 12 | 13 | ## Enumeration members 14 | 15 | ### AUTO 16 | 17 | • **AUTO**: = "AUTO" 18 | 19 | *Defined in [api/types.ts:5581](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5581)* 20 | 21 | ___ 22 | 23 | ### OFF 24 | 25 | • **OFF**: = "OFF" 26 | 27 | *Defined in [api/types.ts:5573](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5573)* 28 | 29 | ___ 30 | 31 | ### ON 32 | 33 | • **ON**: = "ON" 34 | 35 | *Defined in [api/types.ts:5577](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5577)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.digitalidlestate.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DigitalIdleState](_api_types_.digitalidlestate.md) 2 | 3 | # Enumeration: DigitalIdleState 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [closed](_api_types_.digitalidlestate.md#closed) 10 | * [open](_api_types_.digitalidlestate.md#open) 11 | 12 | ## Enumeration members 13 | 14 | ### closed 15 | 16 | • **closed**: = "closed" 17 | 18 | *Defined in [api/types.ts:5247](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5247)* 19 | 20 | ___ 21 | 22 | ### open 23 | 24 | • **open**: = "open" 25 | 26 | *Defined in [api/types.ts:5251](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5251)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.direction.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Direction](_api_types_.direction.md) 2 | 3 | # Enumeration: Direction 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Any](_api_types_.direction.md#any) 10 | * [Left](_api_types_.direction.md#left) 11 | * [Right](_api_types_.direction.md#right) 12 | 13 | ## Enumeration members 14 | 15 | ### Any 16 | 17 | • **Any**: = "Any" 18 | 19 | *Defined in [api/types.ts:5635](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5635)* 20 | 21 | ___ 22 | 23 | ### Left 24 | 25 | • **Left**: = "Left" 26 | 27 | *Defined in [api/types.ts:5627](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5627)* 28 | 29 | ___ 30 | 31 | ### Right 32 | 33 | • **Right**: = "Right" 34 | 35 | *Defined in [api/types.ts:5631](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5631)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.discoverymode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DiscoveryMode](_api_types_.discoverymode.md) 2 | 3 | # Enumeration: DiscoveryMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Discoverable](_api_types_.discoverymode.md#discoverable) 10 | * [NonDiscoverable](_api_types_.discoverymode.md#nondiscoverable) 11 | 12 | ## Enumeration members 13 | 14 | ### Discoverable 15 | 16 | • **Discoverable**: = "Discoverable" 17 | 18 | *Defined in [api/types.ts:4853](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4853)* 19 | 20 | ___ 21 | 22 | ### NonDiscoverable 23 | 24 | • **NonDiscoverable**: = "NonDiscoverable" 25 | 26 | *Defined in [api/types.ts:4857](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4857)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.duplex.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Duplex](_api_types_.duplex.md) 2 | 3 | # Enumeration: Duplex 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Full](_api_types_.duplex.md#full) 10 | * [Half](_api_types_.duplex.md#half) 11 | 12 | ## Enumeration members 13 | 14 | ### Full 15 | 16 | • **Full**: = "Full" 17 | 18 | *Defined in [api/types.ts:4867](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4867)* 19 | 20 | ___ 21 | 22 | ### Half 23 | 24 | • **Half**: = "Half" 25 | 26 | *Defined in [api/types.ts:4871](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4871)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.eflipmode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [EFlipMode](_api_types_.eflipmode.md) 2 | 3 | # Enumeration: EFlipMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Extended](_api_types_.eflipmode.md#extended) 10 | * [OFF](_api_types_.eflipmode.md#off) 11 | * [ON](_api_types_.eflipmode.md#on) 12 | 13 | ## Enumeration members 14 | 15 | ### Extended 16 | 17 | • **Extended**: = "Extended" 18 | 19 | *Defined in [api/types.ts:5269](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5269)* 20 | 21 | ___ 22 | 23 | ### OFF 24 | 25 | • **OFF**: = "OFF" 26 | 27 | *Defined in [api/types.ts:5261](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5261)* 28 | 29 | ___ 30 | 31 | ### ON 32 | 33 | • **ON**: = "ON" 34 | 35 | *Defined in [api/types.ts:5265](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5265)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.enabled.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Enabled](_api_types_.enabled.md) 2 | 3 | # Enumeration: Enabled 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [DISABLED](_api_types_.enabled.md#disabled) 10 | * [ENABLED](_api_types_.enabled.md#enabled) 11 | 12 | ## Enumeration members 13 | 14 | ### DISABLED 15 | 16 | • **DISABLED**: = "DISABLED" 17 | 18 | *Defined in [api/types.ts:5469](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5469)* 19 | 20 | ___ 21 | 22 | ### ENABLED 23 | 24 | • **ENABLED**: = "ENABLED" 25 | 26 | *Defined in [api/types.ts:5465](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5465)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.entity.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Entity](_api_types_.entity.md) 2 | 3 | # Enumeration: Entity 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AudioSource](_api_types_.entity.md#audiosource) 10 | * [Device](_api_types_.entity.md#device) 11 | * [VideoSource](_api_types_.entity.md#videosource) 12 | 13 | ## Enumeration members 14 | 15 | ### AudioSource 16 | 17 | • **AudioSource**: = "AudioSource" 18 | 19 | *Defined in [api/types.ts:4535](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4535)* 20 | 21 | ___ 22 | 23 | ### Device 24 | 25 | • **Device**: = "Device" 26 | 27 | *Defined in [api/types.ts:4527](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4527)* 28 | 29 | ___ 30 | 31 | ### VideoSource 32 | 33 | • **VideoSource**: = "VideoSource" 34 | 35 | *Defined in [api/types.ts:4531](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4531)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.exposuremode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ExposureMode](_api_types_.exposuremode.md) 2 | 3 | # Enumeration: ExposureMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AUTO](_api_types_.exposuremode.md#auto) 10 | * [MANUAL](_api_types_.exposuremode.md#manual) 11 | 12 | ## Enumeration members 13 | 14 | ### AUTO 15 | 16 | • **AUTO**: = "AUTO" 17 | 18 | *Defined in [api/types.ts:5451](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5451)* 19 | 20 | ___ 21 | 22 | ### MANUAL 23 | 24 | • **MANUAL**: = "MANUAL" 25 | 26 | *Defined in [api/types.ts:5455](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5455)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.exposurepriority.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ExposurePriority](_api_types_.exposurepriority.md) 2 | 3 | # Enumeration: ExposurePriority 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [FrameRate](_api_types_.exposurepriority.md#framerate) 10 | * [LowNoise](_api_types_.exposurepriority.md#lownoise) 11 | 12 | ## Enumeration members 13 | 14 | ### FrameRate 15 | 16 | • **FrameRate**: = "FrameRate" 17 | 18 | *Defined in [api/types.ts:5441](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5441)* 19 | 20 | ___ 21 | 22 | ### LowNoise 23 | 24 | • **LowNoise**: = "LowNoise" 25 | 26 | *Defined in [api/types.ts:5437](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5437)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.factorydefaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FactoryDefaultType](_api_types_.factorydefaulttype.md) 2 | 3 | # Enumeration: FactoryDefaultType 4 | 5 | Enumeration describing the available factory default modes. 6 | 7 | ## Index 8 | 9 | ### Enumeration members 10 | 11 | * [Hard](_api_types_.factorydefaulttype.md#hard) 12 | * [Soft](_api_types_.factorydefaulttype.md#soft) 13 | 14 | ## Enumeration members 15 | 16 | ### Hard 17 | 18 | • **Hard**: = "Hard" 19 | 20 | *Defined in [api/types.ts:5151](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5151)* 21 | 22 | Indicates that a hard factory default is requested. 23 | 24 | ___ 25 | 26 | ### Soft 27 | 28 | • **Soft**: = "Soft" 29 | 30 | *Defined in [api/types.ts:5155](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5155)* 31 | 32 | Indicates that a soft factory default is requested. 33 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.ipaddressfiltertype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IPAddressFilterType](_api_types_.ipaddressfiltertype.md) 2 | 3 | # Enumeration: IPAddressFilterType 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Allow](_api_types_.ipaddressfiltertype.md#allow) 10 | * [Deny](_api_types_.ipaddressfiltertype.md#deny) 11 | 12 | ## Enumeration members 13 | 14 | ### Allow 15 | 16 | • **Allow**: = "Allow" 17 | 18 | *Defined in [api/types.ts:4953](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4953)* 19 | 20 | ___ 21 | 22 | ### Deny 23 | 24 | • **Deny**: = "Deny" 25 | 26 | *Defined in [api/types.ts:4957](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4957)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.iptype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IPType](_api_types_.iptype.md) 2 | 3 | # Enumeration: IPType 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [IPv4](_api_types_.iptype.md#ipv4) 10 | * [IPv6](_api_types_.iptype.md#ipv6) 11 | 12 | ## Enumeration members 13 | 14 | ### IPv4 15 | 16 | • **IPv4**: = "IPv4" 17 | 18 | *Defined in [api/types.ts:4939](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4939)* 19 | 20 | ___ 21 | 22 | ### IPv6 23 | 24 | • **IPv6**: = "IPv6" 25 | 26 | *Defined in [api/types.ts:4943](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4943)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.ircutfiltermode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IrCutFilterMode](_api_types_.ircutfiltermode.md) 2 | 3 | # Enumeration: IrCutFilterMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AUTO](_api_types_.ircutfiltermode.md#auto) 10 | * [OFF](_api_types_.ircutfiltermode.md#off) 11 | * [ON](_api_types_.ircutfiltermode.md#on) 12 | 13 | ## Enumeration members 14 | 15 | ### AUTO 16 | 17 | • **AUTO**: = "AUTO" 18 | 19 | *Defined in [api/types.ts:5501](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5501)* 20 | 21 | ___ 22 | 23 | ### OFF 24 | 25 | • **OFF**: = "OFF" 26 | 27 | *Defined in [api/types.ts:5497](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5497)* 28 | 29 | ___ 30 | 31 | ### ON 32 | 33 | • **ON**: = "ON" 34 | 35 | *Defined in [api/types.ts:5493](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5493)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.movestatus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MoveStatus](_api_types_.movestatus.md) 2 | 3 | # Enumeration: MoveStatus 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [IDLE](_api_types_.movestatus.md#idle) 10 | * [MOVING](_api_types_.movestatus.md#moving) 11 | * [UNKNOWN](_api_types_.movestatus.md#unknown) 12 | 13 | ## Enumeration members 14 | 15 | ### IDLE 16 | 17 | • **IDLE**: = "IDLE" 18 | 19 | *Defined in [api/types.ts:4509](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4509)* 20 | 21 | ___ 22 | 23 | ### MOVING 24 | 25 | • **MOVING**: = "MOVING" 26 | 27 | *Defined in [api/types.ts:4513](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4513)* 28 | 29 | ___ 30 | 31 | ### UNKNOWN 32 | 33 | • **UNKNOWN**: = "UNKNOWN" 34 | 35 | *Defined in [api/types.ts:4517](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4517)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.mpeg4profile.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Mpeg4Profile](_api_types_.mpeg4profile.md) 2 | 3 | # Enumeration: Mpeg4Profile 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [ASP](_api_types_.mpeg4profile.md#asp) 10 | * [SP](_api_types_.mpeg4profile.md#sp) 11 | 12 | ## Enumeration members 13 | 14 | ### ASP 15 | 16 | • **ASP**: = "ASP" 17 | 18 | *Defined in [api/types.ts:4657](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4657)* 19 | 20 | ___ 21 | 22 | ### SP 23 | 24 | • **SP**: = "SP" 25 | 26 | *Defined in [api/types.ts:4653](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4653)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.networkhosttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkHostType](_api_types_.networkhosttype.md) 2 | 3 | # Enumeration: NetworkHostType 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [DNS](_api_types_.networkhosttype.md#dns) 10 | * [IPv4](_api_types_.networkhosttype.md#ipv4) 11 | * [IPv6](_api_types_.networkhosttype.md#ipv6) 12 | 13 | ## Enumeration members 14 | 15 | ### DNS 16 | 17 | • **DNS**: = "DNS" 18 | 19 | *Defined in [api/types.ts:4929](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4929)* 20 | 21 | ___ 22 | 23 | ### IPv4 24 | 25 | • **IPv4**: = "IPv4" 26 | 27 | *Defined in [api/types.ts:4921](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4921)* 28 | 29 | ___ 30 | 31 | ### IPv6 32 | 33 | • **IPv6**: = "IPv6" 34 | 35 | *Defined in [api/types.ts:4925](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4925)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.networkprotocoltype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkProtocolType](_api_types_.networkprotocoltype.md) 2 | 3 | # Enumeration: NetworkProtocolType 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [HTTP](_api_types_.networkprotocoltype.md#http) 10 | * [HTTPS](_api_types_.networkprotocoltype.md#https) 11 | * [RTSP](_api_types_.networkprotocoltype.md#rtsp) 12 | 13 | ## Enumeration members 14 | 15 | ### HTTP 16 | 17 | • **HTTP**: = "HTTP" 18 | 19 | *Defined in [api/types.ts:4903](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4903)* 20 | 21 | ___ 22 | 23 | ### HTTPS 24 | 25 | • **HTTPS**: = "HTTPS" 26 | 27 | *Defined in [api/types.ts:4907](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4907)* 28 | 29 | ___ 30 | 31 | ### RTSP 32 | 33 | • **RTSP**: = "RTSP" 34 | 35 | *Defined in [api/types.ts:4911](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4911)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.osdtype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDType](_api_types_.osdtype.md) 2 | 3 | # Enumeration: OSDType 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Extended](_api_types_.osdtype.md#extended) 10 | * [Image](_api_types_.osdtype.md#image) 11 | * [Text](_api_types_.osdtype.md#text) 12 | 13 | ## Enumeration members 14 | 15 | ### Extended 16 | 17 | • **Extended**: = "Extended" 18 | 19 | *Defined in [api/types.ts:5818](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5818)* 20 | 21 | ___ 22 | 23 | ### Image 24 | 25 | • **Image**: = "Image" 26 | 27 | *Defined in [api/types.ts:5814](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5814)* 28 | 29 | ___ 30 | 31 | ### Text 32 | 33 | • **Text**: = "Text" 34 | 35 | *Defined in [api/types.ts:5810](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5810)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.relayidlestate.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RelayIdleState](_api_types_.relayidlestate.md) 2 | 3 | # Enumeration: RelayIdleState 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [closed](_api_types_.relayidlestate.md#closed) 10 | * [open](_api_types_.relayidlestate.md#open) 11 | 12 | ## Enumeration members 13 | 14 | ### closed 15 | 16 | • **closed**: = "closed" 17 | 18 | *Defined in [api/types.ts:5219](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5219)* 19 | 20 | ___ 21 | 22 | ### open 23 | 24 | • **open**: = "open" 25 | 26 | *Defined in [api/types.ts:5223](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5223)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.relaylogicalstate.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RelayLogicalState](_api_types_.relaylogicalstate.md) 2 | 3 | # Enumeration: RelayLogicalState 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [active](_api_types_.relaylogicalstate.md#active) 10 | * [inactive](_api_types_.relaylogicalstate.md#inactive) 11 | 12 | ## Enumeration members 13 | 14 | ### active 15 | 16 | • **active**: = "active" 17 | 18 | *Defined in [api/types.ts:5205](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5205)* 19 | 20 | ___ 21 | 22 | ### inactive 23 | 24 | • **inactive**: = "inactive" 25 | 26 | *Defined in [api/types.ts:5209](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5209)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.relaymode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RelayMode](_api_types_.relaymode.md) 2 | 3 | # Enumeration: RelayMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Bistable](_api_types_.relaymode.md#bistable) 10 | * [Monostable](_api_types_.relaymode.md#monostable) 11 | 12 | ## Enumeration members 13 | 14 | ### Bistable 15 | 16 | • **Bistable**: = "Bistable" 17 | 18 | *Defined in [api/types.ts:5237](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5237)* 19 | 20 | ___ 21 | 22 | ### Monostable 23 | 24 | • **Monostable**: = "Monostable" 25 | 26 | *Defined in [api/types.ts:5233](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5233)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.sceneorientationmode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SceneOrientationMode](_api_types_.sceneorientationmode.md) 2 | 3 | # Enumeration: SceneOrientationMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AUTO](_api_types_.sceneorientationmode.md#auto) 10 | * [MANUAL](_api_types_.sceneorientationmode.md#manual) 11 | 12 | ## Enumeration members 13 | 14 | ### AUTO 15 | 16 | • **AUTO**: = "AUTO" 17 | 18 | *Defined in [api/types.ts:4567](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4567)* 19 | 20 | ___ 21 | 22 | ### MANUAL 23 | 24 | • **MANUAL**: = "MANUAL" 25 | 26 | *Defined in [api/types.ts:4563](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4563)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.scopedefinition.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ScopeDefinition](_api_types_.scopedefinition.md) 2 | 3 | # Enumeration: ScopeDefinition 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Configurable](_api_types_.scopedefinition.md#configurable) 10 | * [Fixed](_api_types_.scopedefinition.md#fixed) 11 | 12 | ## Enumeration members 13 | 14 | ### Configurable 15 | 16 | • **Configurable**: = "Configurable" 17 | 18 | *Defined in [api/types.ts:4843](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4843)* 19 | 20 | ___ 21 | 22 | ### Fixed 23 | 24 | • **Fixed**: = "Fixed" 25 | 26 | *Defined in [api/types.ts:4839](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4839)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.setdatetimetype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SetDateTimeType](_api_types_.setdatetimetype.md) 2 | 3 | # Enumeration: SetDateTimeType 4 | 5 | Indicates that the date and time are set manually. 6 | 7 | ## Index 8 | 9 | ### Enumeration members 10 | 11 | * [Manual](_api_types_.setdatetimetype.md#manual) 12 | * [NTP](_api_types_.setdatetimetype.md#ntp) 13 | 14 | ## Enumeration members 15 | 16 | ### Manual 17 | 18 | • **Manual**: = "Manual" 19 | 20 | *Defined in [api/types.ts:5165](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5165)* 21 | 22 | Indicates that the date and time are set manually. 23 | 24 | ___ 25 | 26 | ### NTP 27 | 28 | • **NTP**: = "NTP" 29 | 30 | *Defined in [api/types.ts:5169](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5169)* 31 | 32 | Indicates that the date and time are set through NTP 33 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.streamtype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [StreamType](_api_types_.streamtype.md) 2 | 3 | # Enumeration: StreamType 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [RTP-Multicast](_api_types_.streamtype.md#rtp-multicast) 10 | * [RTP-Unicast](_api_types_.streamtype.md#rtp-unicast) 11 | 12 | ## Enumeration members 13 | 14 | ### RTP-Multicast 15 | 16 | • **RTP-Multicast**: = "RTP-Multicast" 17 | 18 | *Defined in [api/types.ts:4807](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4807)* 19 | 20 | ___ 21 | 22 | ### RTP-Unicast 23 | 24 | • **RTP-Unicast**: = "RTP-Unicast" 25 | 26 | *Defined in [api/types.ts:4803](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4803)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.systemlogtype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SystemLogType](_api_types_.systemlogtype.md) 2 | 3 | # Enumeration: SystemLogType 4 | 5 | Enumeration describing the available system log modes. 6 | 7 | ## Index 8 | 9 | ### Enumeration members 10 | 11 | * [Access](_api_types_.systemlogtype.md#access) 12 | * [System](_api_types_.systemlogtype.md#system) 13 | 14 | ## Enumeration members 15 | 16 | ### Access 17 | 18 | • **Access**: = "Access" 19 | 20 | *Defined in [api/types.ts:5141](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5141)* 21 | 22 | Indicates that a access log is requested. 23 | 24 | ___ 25 | 26 | ### System 27 | 28 | • **System**: = "System" 29 | 30 | *Defined in [api/types.ts:5137](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5137)* 31 | 32 | Indicates that a system log is requested. 33 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.tonecompensationmode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ToneCompensationMode](_api_types_.tonecompensationmode.md) 2 | 3 | # Enumeration: ToneCompensationMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AUTO](_api_types_.tonecompensationmode.md#auto) 10 | * [OFF](_api_types_.tonecompensationmode.md#off) 11 | * [ON](_api_types_.tonecompensationmode.md#on) 12 | 13 | ## Enumeration members 14 | 15 | ### AUTO 16 | 17 | • **AUTO**: = "AUTO" 18 | 19 | *Defined in [api/types.ts:5563](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5563)* 20 | 21 | ___ 22 | 23 | ### OFF 24 | 25 | • **OFF**: = "OFF" 26 | 27 | *Defined in [api/types.ts:5555](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5555)* 28 | 29 | ___ 30 | 31 | ### ON 32 | 33 | • **ON**: = "ON" 34 | 35 | *Defined in [api/types.ts:5559](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5559)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.videoencoding.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoEncoding](_api_types_.videoencoding.md) 2 | 3 | # Enumeration: VideoEncoding 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [H264](_api_types_.videoencoding.md#h264) 10 | * [JPEG](_api_types_.videoencoding.md#jpeg) 11 | * [MPEG4](_api_types_.videoencoding.md#mpeg4) 12 | 13 | ## Enumeration members 14 | 15 | ### H264 16 | 17 | • **H264**: = "H264" 18 | 19 | *Defined in [api/types.ts:4643](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4643)* 20 | 21 | ___ 22 | 23 | ### JPEG 24 | 25 | • **JPEG**: = "JPEG" 26 | 27 | *Defined in [api/types.ts:4635](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4635)* 28 | 29 | ___ 30 | 31 | ### MPEG4 32 | 33 | • **MPEG4**: = "MPEG4" 34 | 35 | *Defined in [api/types.ts:4639](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4639)* 36 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.whitebalancemode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WhiteBalanceMode](_api_types_.whitebalancemode.md) 2 | 3 | # Enumeration: WhiteBalanceMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [AUTO](_api_types_.whitebalancemode.md#auto) 10 | * [MANUAL](_api_types_.whitebalancemode.md#manual) 11 | 12 | ## Enumeration members 13 | 14 | ### AUTO 15 | 16 | • **AUTO**: = "AUTO" 17 | 18 | *Defined in [api/types.ts:5479](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5479)* 19 | 20 | ___ 21 | 22 | ### MANUAL 23 | 24 | • **MANUAL**: = "MANUAL" 25 | 26 | *Defined in [api/types.ts:5483](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5483)* 27 | -------------------------------------------------------------------------------- /docs/enums/_api_types_.widedynamicmode.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WideDynamicMode](_api_types_.widedynamicmode.md) 2 | 3 | # Enumeration: WideDynamicMode 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [OFF](_api_types_.widedynamicmode.md#off) 10 | * [ON](_api_types_.widedynamicmode.md#on) 11 | 12 | ## Enumeration members 13 | 14 | ### OFF 15 | 16 | • **OFF**: = "OFF" 17 | 18 | *Defined in [api/types.ts:5409](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5409)* 19 | 20 | ___ 21 | 22 | ### ON 23 | 24 | • **ON**: = "ON" 25 | 26 | *Defined in [api/types.ts:5413](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L5413)* 27 | -------------------------------------------------------------------------------- /docs/enums/_soap_request_.soap_node.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["soap/request"](../modules/_soap_request_.md) › [SOAP_NODE](_soap_request_.soap_node.md) 2 | 3 | # Enumeration: SOAP_NODE 4 | 5 | ## Index 6 | 7 | ### Enumeration members 8 | 9 | * [Body](_soap_request_.soap_node.md#body) 10 | * [Envelope](_soap_request_.soap_node.md#envelope) 11 | * [Header](_soap_request_.soap_node.md#header) 12 | 13 | ## Enumeration members 14 | 15 | ### Body 16 | 17 | • **Body**: = "S11:Body" 18 | 19 | *Defined in [soap/request.ts:61](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/request.ts#L61)* 20 | 21 | ___ 22 | 23 | ### Envelope 24 | 25 | • **Envelope**: = "S11:Envelope" 26 | 27 | *Defined in [soap/request.ts:60](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/request.ts#L60)* 28 | 29 | ___ 30 | 31 | ### Header 32 | 33 | • **Header**: = "S11:Header" 34 | 35 | *Defined in [soap/request.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/request.ts#L59)* 36 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.aacdecoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AACDecOptions](_api_types_.aacdecoptions.md) 2 | 3 | # Interface: AACDecOptions 4 | 5 | List of supported bitrates in kbps 6 | 7 | ## Hierarchy 8 | 9 | * **AACDecOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Bitrate](_api_types_.aacdecoptions.md#readonly-bitrate) 16 | * [SampleRateRange](_api_types_.aacdecoptions.md#readonly-sampleraterange) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Bitrate 21 | 22 | • **Bitrate**: *[IntItems](_api_types_.intitems.md)* 23 | 24 | *Defined in [api/types.ts:1153](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1153)* 25 | 26 | ___ 27 | 28 | ### `Readonly` SampleRateRange 29 | 30 | • **SampleRateRange**: *[IntItems](_api_types_.intitems.md)* 31 | 32 | *Defined in [api/types.ts:1154](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1154)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.absolutefocus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AbsoluteFocus](_api_types_.absolutefocus.md) 2 | 3 | # Interface: AbsoluteFocus 4 | 5 | Position parameter for the absolute focus control. 6 | 7 | ## Hierarchy 8 | 9 | * **AbsoluteFocus** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Position](_api_types_.absolutefocus.md#readonly-position) 16 | * [Speed](_api_types_.absolutefocus.md#optional-readonly-speed) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Position 21 | 22 | • **Position**: *number* 23 | 24 | *Defined in [api/types.ts:2790](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2790)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` Speed 29 | 30 | • **Speed**? : *undefined | number* 31 | 32 | *Defined in [api/types.ts:2791](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2791)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.absolutefocusoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AbsoluteFocusOptions](_api_types_.absolutefocusoptions.md) 2 | 3 | # Interface: AbsoluteFocusOptions 4 | 5 | Valid ranges of the position. 6 | 7 | ## Hierarchy 8 | 9 | * **AbsoluteFocusOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Position](_api_types_.absolutefocusoptions.md#readonly-position) 16 | * [Speed](_api_types_.absolutefocusoptions.md#optional-readonly-speed) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Position 21 | 22 | • **Position**: *[FloatRange](_api_types_.floatrange.md)* 23 | 24 | *Defined in [api/types.ts:2828](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2828)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` Speed 29 | 30 | • **Speed**? : *[FloatRange](_api_types_.floatrange.md)* 31 | 32 | *Defined in [api/types.ts:2829](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2829)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.actionengineeventpayloadextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ActionEngineEventPayloadExtension](_api_types_.actionengineeventpayloadextension.md) 2 | 3 | # Interface: ActionEngineEventPayloadExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ActionEngineEventPayloadExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.activeconnection.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ActiveConnection](_api_types_.activeconnection.md) 2 | 3 | # Interface: ActiveConnection 4 | 5 | ## Hierarchy 6 | 7 | * **ActiveConnection** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [CurrentBitrate](_api_types_.activeconnection.md#readonly-currentbitrate) 14 | * [CurrentFps](_api_types_.activeconnection.md#readonly-currentfps) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` CurrentBitrate 19 | 20 | • **CurrentBitrate**: *number* 21 | 22 | *Defined in [api/types.ts:4121](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4121)* 23 | 24 | ___ 25 | 26 | ### `Readonly` CurrentFps 27 | 28 | • **CurrentFps**: *number* 29 | 30 | *Defined in [api/types.ts:4122](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4122)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.analyticsdeviceengineconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AnalyticsDeviceEngineConfigurationExtension](_api_types_.analyticsdeviceengineconfigurationextension.md) 2 | 3 | # Interface: AnalyticsDeviceEngineConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **AnalyticsDeviceEngineConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.analyticsdeviceextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AnalyticsDeviceExtension](_api_types_.analyticsdeviceextension.md) 2 | 3 | # Interface: AnalyticsDeviceExtension 4 | 5 | ## Hierarchy 6 | 7 | * **AnalyticsDeviceExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.analyticsengine.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AnalyticsEngine](_api_types_.analyticsengine.md) 2 | 3 | # Interface: AnalyticsEngine 4 | 5 | ## Hierarchy 6 | 7 | * **AnalyticsEngine** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [AnalyticsEngineConfiguration](_api_types_.analyticsengine.md#readonly-analyticsengineconfiguration) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` AnalyticsEngineConfiguration 18 | 19 | • **AnalyticsEngineConfiguration**: *[AnalyticsDeviceEngineConfiguration](_api_types_.analyticsdeviceengineconfiguration.md)* 20 | 21 | *Defined in [api/types.ts:3973](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3973)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.analyticsengineconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AnalyticsEngineConfigurationExtension](_api_types_.analyticsengineconfigurationextension.md) 2 | 3 | # Interface: AnalyticsEngineConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **AnalyticsEngineConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.analyticsengineinputinfoextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AnalyticsEngineInputInfoExtension](_api_types_.analyticsengineinputinfoextension.md) 2 | 3 | # Interface: AnalyticsEngineInputInfoExtension 4 | 5 | ## Hierarchy 6 | 7 | * **AnalyticsEngineInputInfoExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.analyticsstate.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AnalyticsState](_api_types_.analyticsstate.md) 2 | 3 | # Interface: AnalyticsState 4 | 5 | ## Hierarchy 6 | 7 | * **AnalyticsState** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Error](_api_types_.analyticsstate.md#optional-readonly-error) 14 | * [State](_api_types_.analyticsstate.md#readonly-state) 15 | 16 | ## Properties 17 | 18 | ### `Optional` `Readonly` Error 19 | 20 | • **Error**? : *undefined | string* 21 | 22 | *Defined in [api/types.ts:4075](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4075)* 23 | 24 | ___ 25 | 26 | ### `Readonly` State 27 | 28 | • **State**: *string* 29 | 30 | *Defined in [api/types.ts:4076](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4076)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.anyholder.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AnyHolder](_api_types_.anyholder.md) 2 | 3 | # Interface: AnyHolder 4 | 5 | ## Hierarchy 6 | 7 | * **AnyHolder** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.arrayoffileprogressextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ArrayOfFileProgressExtension](_api_types_.arrayoffileprogressextension.md) 2 | 3 | # Interface: ArrayOfFileProgressExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ArrayOfFileProgressExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.attachmentdata.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AttachmentData](_api_types_.attachmentdata.md) 2 | 3 | # Interface: AttachmentData 4 | 5 | ## Hierarchy 6 | 7 | * **AttachmentData** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audioclasscandidate.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioClassCandidate](_api_types_.audioclasscandidate.md) 2 | 3 | # Interface: AudioClassCandidate 4 | 5 | Indicates audio class label 6 | 7 | ## Hierarchy 8 | 9 | * **AudioClassCandidate** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Likelihood](_api_types_.audioclasscandidate.md#readonly-likelihood) 16 | * [Type](_api_types_.audioclasscandidate.md#readonly-type) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Likelihood 21 | 22 | • **Likelihood**: *number* 23 | 24 | *Defined in [api/types.ts:4100](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4100)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Type 29 | 30 | • **Type**: *[AudioClassType](../enums/_api_types_.audioclasstype.md)* 31 | 32 | *Defined in [api/types.ts:4099](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4099)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audioclassdescriptorextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioClassDescriptorExtension](_api_types_.audioclassdescriptorextension.md) 2 | 3 | # Interface: AudioClassDescriptorExtension 4 | 5 | ## Hierarchy 6 | 7 | * **AudioClassDescriptorExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audiodecoderconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioDecoderConfiguration](_api_types_.audiodecoderconfiguration.md) 2 | 3 | # Interface: AudioDecoderConfiguration 4 | 5 | The Audio Decoder Configuration does not contain any that parameter to configure the 6 | decoding .A decoder shall decode every data it receives (according to its capabilities). 7 | 8 | ## Hierarchy 9 | 10 | * **AudioDecoderConfiguration** 11 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audiodecoderconfigurationoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioDecoderConfigurationOptionsExtension](_api_types_.audiodecoderconfigurationoptionsextension.md) 2 | 3 | # Interface: AudioDecoderConfigurationOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **AudioDecoderConfigurationOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audioencoderconfigurationoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioEncoderConfigurationOptions](_api_types_.audioencoderconfigurationoptions.md) 2 | 3 | # Interface: AudioEncoderConfigurationOptions 4 | 5 | list of supported AudioEncoderConfigurations 6 | 7 | ## Hierarchy 8 | 9 | * **AudioEncoderConfigurationOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Options](_api_types_.audioencoderconfigurationoptions.md#optional-readonly-options) 16 | 17 | ## Properties 18 | 19 | ### `Optional` `Readonly` Options 20 | 21 | • **Options**? : *[AudioEncoderConfigurationOption](_api_types_.audioencoderconfigurationoption.md)* 22 | 23 | *Defined in [api/types.ts:912](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L912)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audiooutput.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioOutput](_api_types_.audiooutput.md) 2 | 3 | # Interface: AudioOutput 4 | 5 | Representation of a physical audio outputs. 6 | 7 | ## Hierarchy 8 | 9 | * **AudioOutput** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audiosource.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioSource](_api_types_.audiosource.md) 2 | 3 | # Interface: AudioSource 4 | 5 | Representation of a physical audio input. 6 | 7 | ## Hierarchy 8 | 9 | * **AudioSource** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Channels](_api_types_.audiosource.md#readonly-channels) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Channels 20 | 21 | • **Channels**: *number* 22 | 23 | *Defined in [api/types.ts:541](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L541)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audiosourceconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioSourceConfiguration](_api_types_.audiosourceconfiguration.md) 2 | 3 | # Interface: AudioSourceConfiguration 4 | 5 | Token of the Audio Source the configuration applies to 6 | 7 | ## Hierarchy 8 | 9 | * **AudioSourceConfiguration** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [SourceToken](_api_types_.audiosourceconfiguration.md#readonly-sourcetoken) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` SourceToken 20 | 21 | • **SourceToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* 22 | 23 | *Defined in [api/types.ts:880](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L880)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.audiosourceoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [AudioSourceOptionsExtension](_api_types_.audiosourceoptionsextension.md) 2 | 3 | # Interface: AudioSourceOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **AudioSourceOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.backlightcompensation.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [BacklightCompensation](_api_types_.backlightcompensation.md) 2 | 3 | # Interface: BacklightCompensation 4 | 5 | Backlight compensation mode (on/off). 6 | 7 | ## Hierarchy 8 | 9 | * **BacklightCompensation** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Level](_api_types_.backlightcompensation.md#readonly-level) 16 | * [Mode](_api_types_.backlightcompensation.md#readonly-mode) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Level 21 | 22 | • **Level**: *number* 23 | 24 | *Defined in [api/types.ts:2702](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2702)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Mode 29 | 30 | • **Mode**: *[BacklightCompensationMode](../enums/_api_types_.backlightcompensationmode.md)* 31 | 32 | *Defined in [api/types.ts:2701](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2701)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.backlightcompensationoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [BacklightCompensationOptions](_api_types_.backlightcompensationoptions.md) 2 | 3 | # Interface: BacklightCompensationOptions 4 | 5 | ## Hierarchy 6 | 7 | * **BacklightCompensationOptions** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Level](_api_types_.backlightcompensationoptions.md#readonly-level) 14 | * [Mode](_api_types_.backlightcompensationoptions.md#readonly-mode) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` Level 19 | 20 | • **Level**: *[FloatRange](_api_types_.floatrange.md)* 21 | 22 | *Defined in [api/types.ts:2734](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2734)* 23 | 24 | ___ 25 | 26 | ### `Readonly` Mode 27 | 28 | • **Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* 29 | 30 | *Defined in [api/types.ts:2733](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2733)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.backupfile.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [BackupFile](_api_types_.backupfile.md) 2 | 3 | # Interface: BackupFile 4 | 5 | ## Hierarchy 6 | 7 | * **BackupFile** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Data](_api_types_.backupfile.md#readonly-data) 14 | * [Name](_api_types_.backupfile.md#readonly-name) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` Data 19 | 20 | • **Data**: *[AttachmentData](_api_types_.attachmentdata.md)* 21 | 22 | *Defined in [api/types.ts:1976](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1976)* 23 | 24 | ___ 25 | 26 | ### `Readonly` Name 27 | 28 | • **Name**: *string* 29 | 30 | *Defined in [api/types.ts:1975](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1975)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.binarydata.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [BinaryData](_api_types_.binarydata.md) 2 | 3 | # Interface: BinaryData 4 | 5 | base64 encoded binary data. 6 | 7 | ## Hierarchy 8 | 9 | * **BinaryData** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Data](_api_types_.binarydata.md#readonly-data) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Data 20 | 21 | • **Data**: *string* 22 | 23 | *Defined in [api/types.ts:1962](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1962)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.body.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Body](_api_types_.body.md) 2 | 3 | # Interface: Body 4 | 5 | Prose in the spec does not specify that attributes are allowed on the Body element 6 | 7 | ## Hierarchy 8 | 9 | * **Body** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.capabilitiesextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [CapabilitiesExtension2](_api_types_.capabilitiesextension2.md) 2 | 3 | # Interface: CapabilitiesExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **CapabilitiesExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.celllayout.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [CellLayout](_api_types_.celllayout.md) 2 | 3 | # Interface: CellLayout 4 | 5 | Mapping of the cell grid to the Video frame. The cell grid is starting from the upper left corner and x dimension is going from left to right and the y dimension from up to down. 6 | 7 | ## Hierarchy 8 | 9 | * **CellLayout** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Transformation](_api_types_.celllayout.md#readonly-transformation) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Transformation 20 | 21 | • **Transformation**: *[Transformation](_api_types_.transformation.md)* 22 | 23 | *Defined in [api/types.ts:3494](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3494)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.certificate.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Certificate](_api_types_.certificate.md) 2 | 3 | # Interface: Certificate 4 | 5 | Certificate id. 6 | 7 | ## Hierarchy 8 | 9 | * **Certificate** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Certificate](_api_types_.certificate.md#readonly-certificate) 16 | * [CertificateID](_api_types_.certificate.md#readonly-certificateid) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Certificate 21 | 22 | • **Certificate**: *[BinaryData](_api_types_.binarydata.md)* 23 | 24 | *Defined in [api/types.ts:2103](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2103)* 25 | 26 | ___ 27 | 28 | ### `Readonly` CertificateID 29 | 30 | • **CertificateID**: *string* 31 | 32 | *Defined in [api/types.ts:2102](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2102)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.certificategenerationparametersextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [CertificateGenerationParametersExtension](_api_types_.certificategenerationparametersextension.md) 2 | 3 | # Interface: CertificateGenerationParametersExtension 4 | 5 | ## Hierarchy 6 | 7 | * **CertificateGenerationParametersExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.certificateinformationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [CertificateInformationExtension](_api_types_.certificateinformationextension.md) 2 | 3 | # Interface: CertificateInformationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **CertificateInformationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.certificatestatus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [CertificateStatus](_api_types_.certificatestatus.md) 2 | 3 | # Interface: CertificateStatus 4 | 5 | Certificate id. 6 | 7 | ## Hierarchy 8 | 9 | * **CertificateStatus** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [CertificateID](_api_types_.certificatestatus.md#readonly-certificateid) 16 | * [Status](_api_types_.certificatestatus.md#readonly-status) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` CertificateID 21 | 22 | • **CertificateID**: *string* 23 | 24 | *Defined in [api/types.ts:2110](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2110)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Status 29 | 30 | • **Status**: *boolean* 31 | 32 | *Defined in [api/types.ts:2111](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2111)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.certificateusage.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [CertificateUsage](_api_types_.certificateusage.md) 2 | 3 | # Interface: CertificateUsage 4 | 5 | ## Hierarchy 6 | 7 | * **CertificateUsage** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.color.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Color](_api_types_.color.md) 2 | 3 | # Interface: Color 4 | 5 | Acceptable values: 6 | 7 | http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr 8 | X attribute = Y value 9 | Y attribute = Cb value 10 | Z attribute = Cr value 11 | 12 | http://www.onvif.org/ver10/colorspace/RGB - RGB 13 | X attribute = R value 14 | Y attribute = G value 15 | Z attribute = B value 16 | 17 | If the Colorspace attribute is absent, YCbCr is implied. 18 | 19 | Deprecated values: 20 | 21 | http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV 22 | http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*) 23 | http://www.onvif.org/ver10/colorspace/HSV - HSV 24 | 25 | ## Hierarchy 26 | 27 | * **Color** 28 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.colorcovariance.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ColorCovariance](_api_types_.colorcovariance.md) 2 | 3 | # Interface: ColorCovariance 4 | 5 | Acceptable values are the same as in tt:Color. 6 | 7 | ## Hierarchy 8 | 9 | * **ColorCovariance** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.config.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Config](_api_types_.config.md) 2 | 3 | # Interface: Config 4 | 5 | List of configuration parameters as defined in the corresponding description. 6 | 7 | ## Hierarchy 8 | 9 | * **Config** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Parameters](_api_types_.config.md#readonly-parameters) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Parameters 20 | 21 | • **Parameters**: *[ItemList](_api_types_.itemlist.md)* 22 | 23 | *Defined in [api/types.ts:3399](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3399)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.configdescriptionextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ConfigDescriptionExtension](_api_types_.configdescriptionextension.md) 2 | 3 | # Interface: ConfigDescriptionExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ConfigDescriptionExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.configurationentity.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ConfigurationEntity](_api_types_.configurationentity.md) 2 | 3 | # Interface: ConfigurationEntity 4 | 5 | Base type defining the common properties of a configuration. 6 | 7 | ## Hierarchy 8 | 9 | * **ConfigurationEntity** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Name](_api_types_.configurationentity.md#readonly-name) 16 | * [UseCount](_api_types_.configurationentity.md#readonly-usecount) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Name 21 | 22 | • **Name**: *[Name](_api_types_.configurationentity.md#readonly-name)* 23 | 24 | *Defined in [api/types.ts:587](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L587)* 25 | 26 | ___ 27 | 28 | ### `Readonly` UseCount 29 | 30 | • **UseCount**: *number* 31 | 32 | *Defined in [api/types.ts:588](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L588)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.continuousfocus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ContinuousFocus](_api_types_.continuousfocus.md) 2 | 3 | # Interface: ContinuousFocus 4 | 5 | Speed parameter for the Continuous focus control. 6 | 7 | ## Hierarchy 8 | 9 | * **ContinuousFocus** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Speed](_api_types_.continuousfocus.md#readonly-speed) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Speed 20 | 21 | • **Speed**: *number* 22 | 23 | *Defined in [api/types.ts:2810](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2810)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.continuousfocusoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ContinuousFocusOptions](_api_types_.continuousfocusoptions.md) 2 | 3 | # Interface: ContinuousFocusOptions 4 | 5 | Valid ranges of the speed. 6 | 7 | ## Hierarchy 8 | 9 | * **ContinuousFocusOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Speed](_api_types_.continuousfocusoptions.md#readonly-speed) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Speed 20 | 21 | • **Speed**: *[FloatRange](_api_types_.floatrange.md)* 22 | 23 | *Defined in [api/types.ts:2848](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2848)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.date.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Date](_api_types_.date.md) 2 | 3 | # Interface: Date 4 | 5 | Range is 1 to 12. 6 | 7 | ## Hierarchy 8 | 9 | * **Date** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Day](_api_types_.date.md#readonly-day) 16 | * [Month](_api_types_.date.md#readonly-month) 17 | * [Year](_api_types_.date.md#readonly-year) 18 | 19 | ## Properties 20 | 21 | ### `Readonly` Day 22 | 23 | • **Day**: *number* 24 | 25 | *Defined in [api/types.ts:2026](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2026)* 26 | 27 | ___ 28 | 29 | ### `Readonly` Month 30 | 31 | • **Month**: *number* 32 | 33 | *Defined in [api/types.ts:2025](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2025)* 34 | 35 | ___ 36 | 37 | ### `Readonly` Year 38 | 39 | • **Year**: *number* 40 | 41 | *Defined in [api/types.ts:2024](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2024)* 42 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.datetime.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DateTime](_api_types_.datetime.md) 2 | 3 | # Interface: DateTime 4 | 5 | ## Hierarchy 6 | 7 | * **DateTime** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Date](_api_types_.datetime.md#readonly-date) 14 | * [Time](_api_types_.datetime.md#readonly-time) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` Date 19 | 20 | • **Date**: *[Date](_api_types_.date.md)* 21 | 22 | *Defined in [api/types.ts:2017](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2017)* 23 | 24 | ___ 25 | 26 | ### `Readonly` Time 27 | 28 | • **Time**: *[Time](_api_types_.time.md)* 29 | 30 | *Defined in [api/types.ts:2016](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2016)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.datetimerange.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DateTimeRange](_api_types_.datetimerange.md) 2 | 3 | # Interface: DateTimeRange 4 | 5 | ## Hierarchy 6 | 7 | * **DateTimeRange** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [From](_api_types_.datetimerange.md#readonly-from) 14 | * [Until](_api_types_.datetimerange.md#readonly-until) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` From 19 | 20 | • **From**: *string* 21 | 22 | *Defined in [api/types.ts:3610](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3610)* 23 | 24 | ___ 25 | 26 | ### `Readonly` Until 27 | 28 | • **Until**: *string* 29 | 30 | *Defined in [api/types.ts:3611](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3611)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.defoggingextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DefoggingExtension](_api_types_.defoggingextension.md) 2 | 3 | # Interface: DefoggingExtension 4 | 5 | ## Hierarchy 6 | 7 | * **DefoggingExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.defoggingoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DefoggingOptions](_api_types_.defoggingoptions.md) 2 | 3 | # Interface: DefoggingOptions 4 | 5 | Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type. 6 | 7 | ## Hierarchy 8 | 9 | * **DefoggingOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Level](_api_types_.defoggingoptions.md#readonly-level) 16 | * [Mode](_api_types_.defoggingoptions.md#readonly-mode) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Level 21 | 22 | • **Level**: *boolean* 23 | 24 | *Defined in [api/types.ts:3290](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3290)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Mode 29 | 30 | • **Mode**: *string* 31 | 32 | *Defined in [api/types.ts:3289](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3289)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.detail.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [detail](_api_types_.detail.md) 2 | 3 | # Interface: detail 4 | 5 | ## Hierarchy 6 | 7 | * **detail** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.devicecapabilitiesextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DeviceCapabilitiesExtension](_api_types_.devicecapabilitiesextension.md) 2 | 3 | # Interface: DeviceCapabilitiesExtension 4 | 5 | ## Hierarchy 6 | 7 | * **DeviceCapabilitiesExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.deviceentity.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DeviceEntity](_api_types_.deviceentity.md) 2 | 3 | # Interface: DeviceEntity 4 | 5 | Base class for physical entities like inputs and outputs. 6 | 7 | ## Hierarchy 8 | 9 | * **DeviceEntity** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.digitalinput.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DigitalInput](_api_types_.digitalinput.md) 2 | 3 | # Interface: DigitalInput 4 | 5 | Indicate the Digital IdleState status. 6 | 7 | ## Hierarchy 8 | 9 | * **DigitalInput** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.displaycapabilities.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DisplayCapabilities](_api_types_.displaycapabilities.md) 2 | 3 | # Interface: DisplayCapabilities 4 | 5 | Indication that the SetLayout command supports only predefined layouts. 6 | 7 | ## Hierarchy 8 | 9 | * **DisplayCapabilities** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [FixedLayout](_api_types_.displaycapabilities.md#readonly-fixedlayout) 16 | * [XAddr](_api_types_.displaycapabilities.md#readonly-xaddr) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` FixedLayout 21 | 22 | • **FixedLayout**: *boolean* 23 | 24 | *Defined in [api/types.ts:1885](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1885)* 25 | 26 | ___ 27 | 28 | ### `Readonly` XAddr 29 | 30 | • **XAddr**: *string* 31 | 32 | *Defined in [api/types.ts:1884](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1884)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.dnsinformationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DNSInformationExtension](_api_types_.dnsinformationextension.md) 2 | 3 | # Interface: DNSInformationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **DNSInformationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.dot11availablenetworksextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Dot11AvailableNetworksExtension](_api_types_.dot11availablenetworksextension.md) 2 | 3 | # Interface: Dot11AvailableNetworksExtension 4 | 5 | ## Hierarchy 6 | 7 | * **Dot11AvailableNetworksExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.dot11psksetextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Dot11PSKSetExtension](_api_types_.dot11psksetextension.md) 2 | 3 | # Interface: Dot11PSKSetExtension 4 | 5 | ## Hierarchy 6 | 7 | * **Dot11PSKSetExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.dot11securityconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Dot11SecurityConfigurationExtension](_api_types_.dot11securityconfigurationextension.md) 2 | 3 | # Interface: Dot11SecurityConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **Dot11SecurityConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.dot1xconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Dot1XConfigurationExtension](_api_types_.dot1xconfigurationextension.md) 2 | 3 | # Interface: Dot1XConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **Dot1XConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.dot3configuration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Dot3Configuration](_api_types_.dot3configuration.md) 2 | 3 | # Interface: Dot3Configuration 4 | 5 | ## Hierarchy 6 | 7 | * **Dot3Configuration** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.durationrange.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DurationRange](_api_types_.durationrange.md) 2 | 3 | # Interface: DurationRange 4 | 5 | Range of duration greater equal Min duration and less equal Max duration. 6 | 7 | ## Hierarchy 8 | 9 | * **DurationRange** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Max](_api_types_.durationrange.md#readonly-max) 16 | * [Min](_api_types_.durationrange.md#readonly-min) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Max 21 | 22 | • **Max**: *string* 23 | 24 | *Defined in [api/types.ts:490](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L490)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Min 29 | 30 | • **Min**: *string* 31 | 32 | *Defined in [api/types.ts:489](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L489)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.dynamicdnsinformationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [DynamicDNSInformationExtension](_api_types_.dynamicdnsinformationextension.md) 2 | 3 | # Interface: DynamicDNSInformationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **DynamicDNSInformationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.eapmethodextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [EapMethodExtension](_api_types_.eapmethodextension.md) 2 | 3 | # Interface: EapMethodExtension 4 | 5 | ## Hierarchy 6 | 7 | * **EapMethodExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.eflip.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [EFlip](_api_types_.eflip.md) 2 | 3 | # Interface: EFlip 4 | 5 | Parameter to enable/disable E-Flip feature. 6 | 7 | ## Hierarchy 8 | 9 | * **EFlip** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Mode](_api_types_.eflip.md#readonly-mode) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Mode 20 | 21 | • **Mode**: *[EFlipMode](../enums/_api_types_.eflipmode.md)* 22 | 23 | *Defined in [api/types.ts:2329](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2329)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.eflipoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [EFlipOptions](_api_types_.eflipoptions.md) 2 | 3 | # Interface: EFlipOptions 4 | 5 | Options of EFlip mode parameter. 6 | 7 | ## Hierarchy 8 | 9 | * **EFlipOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Extension](_api_types_.eflipoptions.md#optional-readonly-extension) 16 | * [Mode](_api_types_.eflipoptions.md#optional-readonly-mode) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Extension 21 | 22 | • **Extension**? : *[EFlipOptionsExtension](_api_types_.eflipoptionsextension.md)* 23 | 24 | *Defined in [api/types.ts:2377](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2377)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` Mode 29 | 30 | • **Mode**? : *[EFlipMode](../enums/_api_types_.eflipmode.md)* 31 | 32 | *Defined in [api/types.ts:2376](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2376)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.eflipoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [EFlipOptionsExtension](_api_types_.eflipoptionsextension.md) 2 | 3 | # Interface: EFlipOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **EFlipOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.envelope.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Envelope](_api_types_.envelope.md) 2 | 3 | # Interface: Envelope 4 | 5 | ## Hierarchy 6 | 7 | * **Envelope** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.eventfilter.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [EventFilter](_api_types_.eventfilter.md) 2 | 3 | # Interface: EventFilter 4 | 5 | ## Hierarchy 6 | 7 | * **EventFilter** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.eventsubscription.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [EventSubscription](_api_types_.eventsubscription.md) 2 | 3 | # Interface: EventSubscription 4 | 5 | Subcription handling in the same way as base notification subscription. 6 | 7 | ## Hierarchy 8 | 9 | * **EventSubscription** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Filter](_api_types_.eventsubscription.md#optional-readonly-filter) 16 | * [SubscriptionPolicy](_api_types_.eventsubscription.md#optional-readonly-subscriptionpolicy) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Filter 21 | 22 | • **Filter**? : *any* 23 | 24 | *Defined in [api/types.ts:982](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L982)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` SubscriptionPolicy 29 | 30 | • **SubscriptionPolicy**? : *any* 31 | 32 | *Defined in [api/types.ts:983](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L983)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.fileprogress.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FileProgress](_api_types_.fileprogress.md) 2 | 3 | # Interface: FileProgress 4 | 5 | Exported file name 6 | 7 | ## Hierarchy 8 | 9 | * **FileProgress** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [FileName](_api_types_.fileprogress.md#readonly-filename) 16 | * [Progress](_api_types_.fileprogress.md#readonly-progress) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` FileName 21 | 22 | • **FileName**: *string* 23 | 24 | *Defined in [api/types.ts:4329](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4329)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Progress 29 | 30 | • **Progress**: *number* 31 | 32 | *Defined in [api/types.ts:4330](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4330)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.filtertype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FilterType](_api_types_.filtertype.md) 2 | 3 | # Interface: FilterType 4 | 5 | ## Hierarchy 6 | 7 | * **FilterType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.floatitems.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FloatItems](_api_types_.floatitems.md) 2 | 3 | # Interface: FloatItems 4 | 5 | ## Hierarchy 6 | 7 | * **FloatItems** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Items](_api_types_.floatitems.md#optional-readonly-items) 14 | 15 | ## Properties 16 | 17 | ### `Optional` `Readonly` Items 18 | 19 | • **Items**? : *undefined | number* 20 | 21 | *Defined in [api/types.ts:504](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L504)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.floatrange.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FloatRange](_api_types_.floatrange.md) 2 | 3 | # Interface: FloatRange 4 | 5 | Range of values greater equal Min value and less equal Max value. 6 | 7 | ## Hierarchy 8 | 9 | * **FloatRange** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Max](_api_types_.floatrange.md#readonly-max) 16 | * [Min](_api_types_.floatrange.md#readonly-min) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Max 21 | 22 | • **Max**: *number* 23 | 24 | *Defined in [api/types.ts:482](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L482)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Min 29 | 30 | • **Min**: *number* 31 | 32 | *Defined in [api/types.ts:481](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L481)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.focusconfiguration20extension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FocusConfiguration20Extension](_api_types_.focusconfiguration20extension.md) 2 | 3 | # Interface: FocusConfiguration20Extension 4 | 5 | ## Hierarchy 6 | 7 | * **FocusConfiguration20Extension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.focusoptions20extension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FocusOptions20Extension](_api_types_.focusoptions20extension.md) 2 | 3 | # Interface: FocusOptions20Extension 4 | 5 | Supported options for auto focus. Options shall be chosen from tt:AFModes. 6 | 7 | ## Hierarchy 8 | 9 | * **FocusOptions20Extension** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [AFModes](_api_types_.focusoptions20extension.md#optional-readonly-afmodes) 16 | 17 | ## Properties 18 | 19 | ### `Optional` `Readonly` AFModes 20 | 21 | • **AFModes**? : *[StringAttrList](../modules/_api_types_.md#stringattrlist)* 22 | 23 | *Defined in [api/types.ts:3274](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3274)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.focusstatus20extension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [FocusStatus20Extension](_api_types_.focusstatus20extension.md) 2 | 3 | # Interface: FocusStatus20Extension 4 | 5 | ## Hierarchy 6 | 7 | * **FocusStatus20Extension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.g711decoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [G711DecOptions](_api_types_.g711decoptions.md) 2 | 3 | # Interface: G711DecOptions 4 | 5 | List of supported bitrates in kbps 6 | 7 | ## Hierarchy 8 | 9 | * **G711DecOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Bitrate](_api_types_.g711decoptions.md#readonly-bitrate) 16 | * [SampleRateRange](_api_types_.g711decoptions.md#readonly-sampleraterange) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Bitrate 21 | 22 | • **Bitrate**: *[IntItems](_api_types_.intitems.md)* 23 | 24 | *Defined in [api/types.ts:1145](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1145)* 25 | 26 | ___ 27 | 28 | ### `Readonly` SampleRateRange 29 | 30 | • **SampleRateRange**: *[IntItems](_api_types_.intitems.md)* 31 | 32 | *Defined in [api/types.ts:1146](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1146)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.g726decoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [G726DecOptions](_api_types_.g726decoptions.md) 2 | 3 | # Interface: G726DecOptions 4 | 5 | List of supported bitrates in kbps 6 | 7 | ## Hierarchy 8 | 9 | * **G726DecOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Bitrate](_api_types_.g726decoptions.md#readonly-bitrate) 16 | * [SampleRateRange](_api_types_.g726decoptions.md#readonly-sampleraterange) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Bitrate 21 | 22 | • **Bitrate**: *[IntItems](_api_types_.intitems.md)* 23 | 24 | *Defined in [api/types.ts:1161](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1161)* 25 | 26 | ___ 27 | 28 | ### `Readonly` SampleRateRange 29 | 30 | • **SampleRateRange**: *[IntItems](_api_types_.intitems.md)* 31 | 32 | *Defined in [api/types.ts:1162](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1162)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.genericeappwdconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [GenericEapPwdConfigurationExtension](_api_types_.genericeappwdconfigurationextension.md) 2 | 3 | # Interface: GenericEapPwdConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **GenericEapPwdConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.geolocation.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [GeoLocation](_api_types_.geolocation.md) 2 | 3 | # Interface: GeoLocation 4 | 5 | East west location as angle. 6 | 7 | ## Hierarchy 8 | 9 | * **GeoLocation** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.geoorientation.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [GeoOrientation](_api_types_.geoorientation.md) 2 | 3 | # Interface: GeoOrientation 4 | 5 | Rotation around the x axis. 6 | 7 | ## Hierarchy 8 | 9 | * **GeoOrientation** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.gettracksresponselist.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [GetTracksResponseList](_api_types_.gettracksresponselist.md) 2 | 3 | # Interface: GetTracksResponseList 4 | 5 | Configuration of a track. 6 | 7 | ## Hierarchy 8 | 9 | * **GetTracksResponseList** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Track](_api_types_.gettracksresponselist.md#optional-readonly-track) 16 | 17 | ## Properties 18 | 19 | ### `Optional` `Readonly` Track 20 | 21 | • **Track**? : *[GetTracksResponseItem](_api_types_.gettracksresponseitem.md)* 22 | 23 | *Defined in [api/types.ts:3852](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3852)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.h264options2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [H264Options2](_api_types_.h264options2.md) 2 | 3 | # Interface: H264Options2 4 | 5 | Supported range of encoded bitrate in kbps. 6 | 7 | ## Hierarchy 8 | 9 | * **H264Options2** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [BitrateRange](_api_types_.h264options2.md#readonly-bitraterange) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` BitrateRange 20 | 21 | • **BitrateRange**: *[IntRange](_api_types_.intrange.md)* 22 | 23 | *Defined in [api/types.ts:836](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L836)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.header.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Header](_api_types_.header.md) 2 | 3 | # Interface: Header 4 | 5 | ## Hierarchy 6 | 7 | * **Header** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.hostnameinformationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [HostnameInformationExtension](_api_types_.hostnameinformationextension.md) 2 | 3 | # Interface: HostnameInformationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **HostnameInformationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagestabilizationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImageStabilizationExtension](_api_types_.imagestabilizationextension.md) 2 | 3 | # Interface: ImageStabilizationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ImageStabilizationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagestabilizationoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImageStabilizationOptionsExtension](_api_types_.imagestabilizationoptionsextension.md) 2 | 3 | # Interface: ImageStabilizationOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ImageStabilizationOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagingcapabilities.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImagingCapabilities](_api_types_.imagingcapabilities.md) 2 | 3 | # Interface: ImagingCapabilities 4 | 5 | Imaging service URI. 6 | 7 | ## Hierarchy 8 | 9 | * **ImagingCapabilities** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [XAddr](_api_types_.imagingcapabilities.md#readonly-xaddr) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` XAddr 20 | 21 | • **XAddr**: *string* 22 | 23 | *Defined in [api/types.ts:1858](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1858)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagingoptions20extension4.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImagingOptions20Extension4](_api_types_.imagingoptions20extension4.md) 2 | 3 | # Interface: ImagingOptions20Extension4 4 | 5 | ## Hierarchy 6 | 7 | * **ImagingOptions20Extension4** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagingsettingsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImagingSettingsExtension](_api_types_.imagingsettingsextension.md) 2 | 3 | # Interface: ImagingSettingsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ImagingSettingsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagingsettingsextension204.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImagingSettingsExtension204](_api_types_.imagingsettingsextension204.md) 2 | 3 | # Interface: ImagingSettingsExtension204 4 | 5 | ## Hierarchy 6 | 7 | * **ImagingSettingsExtension204** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagingstatus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImagingStatus](_api_types_.imagingstatus.md) 2 | 3 | # Interface: ImagingStatus 4 | 5 | ## Hierarchy 6 | 7 | * **ImagingStatus** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [FocusStatus](_api_types_.imagingstatus.md#readonly-focusstatus) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` FocusStatus 18 | 19 | • **FocusStatus**: *[FocusStatus](_api_types_.focusstatus.md)* 20 | 21 | *Defined in [api/types.ts:2616](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2616)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.imagingstatus20extension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ImagingStatus20Extension](_api_types_.imagingstatus20extension.md) 2 | 3 | # Interface: ImagingStatus20Extension 4 | 5 | ## Hierarchy 6 | 7 | * **ImagingStatus20Extension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.intitems.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IntItems](_api_types_.intitems.md) 2 | 3 | # Interface: IntItems 4 | 5 | List of values. 6 | 7 | ## Hierarchy 8 | 9 | * **IntItems** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Items](_api_types_.intitems.md#optional-readonly-items) 16 | 17 | ## Properties 18 | 19 | ### `Optional` `Readonly` Items 20 | 21 | • **Items**? : *undefined | number* 22 | 23 | *Defined in [api/types.ts:497](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L497)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.intrange.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IntRange](_api_types_.intrange.md) 2 | 3 | # Interface: IntRange 4 | 5 | Range of values greater equal Min value and less equal Max value. 6 | 7 | ## Hierarchy 8 | 9 | * **IntRange** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Max](_api_types_.intrange.md#readonly-max) 16 | * [Min](_api_types_.intrange.md#readonly-min) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Max 21 | 22 | • **Max**: *number* 23 | 24 | *Defined in [api/types.ts:282](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L282)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Min 29 | 30 | • **Min**: *number* 31 | 32 | *Defined in [api/types.ts:281](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L281)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.intrectangle.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IntRectangle](_api_types_.intrectangle.md) 2 | 3 | # Interface: IntRectangle 4 | 5 | Rectangle defined by lower left corner position and size. Units are pixel. 6 | 7 | ## Hierarchy 8 | 9 | * **IntRectangle** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.invalidfilterfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [InvalidFilterFaultType](_api_types_.invalidfilterfaulttype.md) 2 | 3 | # Interface: InvalidFilterFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **InvalidFilterFaultType** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [UnknownFilter](_api_types_.invalidfilterfaulttype.md#readonly-unknownfilter) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` UnknownFilter 18 | 19 | • **UnknownFilter**: *any* 20 | 21 | *Defined in [api/types.ts:160](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L160)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.invalidmessagecontentexpressionfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [InvalidMessageContentExpressionFaultType](_api_types_.invalidmessagecontentexpressionfaulttype.md) 2 | 3 | # Interface: InvalidMessageContentExpressionFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **InvalidMessageContentExpressionFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.invalidproducerpropertiesexpressionfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [InvalidProducerPropertiesExpressionFaultType](_api_types_.invalidproducerpropertiesexpressionfaulttype.md) 2 | 3 | # Interface: InvalidProducerPropertiesExpressionFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **InvalidProducerPropertiesExpressionFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.invalidtopicexpressionfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [InvalidTopicExpressionFaultType](_api_types_.invalidtopicexpressionfaulttype.md) 2 | 3 | # Interface: InvalidTopicExpressionFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **InvalidTopicExpressionFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.iocapabilitiesextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IOCapabilitiesExtension2](_api_types_.iocapabilitiesextension2.md) 2 | 3 | # Interface: IOCapabilitiesExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **IOCapabilitiesExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ipaddressfilterextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IPAddressFilterExtension](_api_types_.ipaddressfilterextension.md) 2 | 3 | # Interface: IPAddressFilterExtension 4 | 5 | ## Hierarchy 6 | 7 | * **IPAddressFilterExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ipv4networkinterface.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IPv4NetworkInterface](_api_types_.ipv4networkinterface.md) 2 | 3 | # Interface: IPv4NetworkInterface 4 | 5 | Indicates whether or not IPv4 is enabled. 6 | 7 | ## Hierarchy 8 | 9 | * **IPv4NetworkInterface** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Config](_api_types_.ipv4networkinterface.md#readonly-config) 16 | * [Enabled](_api_types_.ipv4networkinterface.md#readonly-enabled) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Config 21 | 22 | • **Config**: *[IPv4Configuration](_api_types_.ipv4configuration.md)* 23 | 24 | *Defined in [api/types.ts:1289](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1289)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Enabled 29 | 30 | • **Enabled**: *boolean* 31 | 32 | *Defined in [api/types.ts:1288](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1288)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ipv6configurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IPv6ConfigurationExtension](_api_types_.ipv6configurationextension.md) 2 | 3 | # Interface: IPv6ConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **IPv6ConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ipv6networkinterface.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IPv6NetworkInterface](_api_types_.ipv6networkinterface.md) 2 | 3 | # Interface: IPv6NetworkInterface 4 | 5 | Indicates whether or not IPv6 is enabled. 6 | 7 | ## Hierarchy 8 | 9 | * **IPv6NetworkInterface** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Config](_api_types_.ipv6networkinterface.md#optional-readonly-config) 16 | * [Enabled](_api_types_.ipv6networkinterface.md#readonly-enabled) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Config 21 | 22 | • **Config**? : *[IPv6Configuration](_api_types_.ipv6configuration.md)* 23 | 24 | *Defined in [api/types.ts:1281](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1281)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Enabled 29 | 30 | • **Enabled**: *boolean* 31 | 32 | *Defined in [api/types.ts:1280](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1280)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ircutfilterautoadjustmentextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IrCutFilterAutoAdjustmentExtension](_api_types_.ircutfilterautoadjustmentextension.md) 2 | 3 | # Interface: IrCutFilterAutoAdjustmentExtension 4 | 5 | ## Hierarchy 6 | 7 | * **IrCutFilterAutoAdjustmentExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ircutfilterautoadjustmentoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [IrCutFilterAutoAdjustmentOptionsExtension](_api_types_.ircutfilterautoadjustmentoptionsextension.md) 2 | 3 | # Interface: IrCutFilterAutoAdjustmentOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **IrCutFilterAutoAdjustmentOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.itemlistdescriptionextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ItemListDescriptionExtension](_api_types_.itemlistdescriptionextension.md) 2 | 3 | # Interface: ItemListDescriptionExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ItemListDescriptionExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.itemlistextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ItemListExtension](_api_types_.itemlistextension.md) 2 | 3 | # Interface: ItemListExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ItemListExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.jpegoptions2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [JpegOptions2](_api_types_.jpegoptions2.md) 2 | 3 | # Interface: JpegOptions2 4 | 5 | Supported range of encoded bitrate in kbps. 6 | 7 | ## Hierarchy 8 | 9 | * **JpegOptions2** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [BitrateRange](_api_types_.jpegoptions2.md#readonly-bitraterange) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` BitrateRange 20 | 21 | • **BitrateRange**: *[IntRange](_api_types_.intrange.md)* 22 | 23 | *Defined in [api/types.ts:800](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L800)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.layout.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Layout](_api_types_.layout.md) 2 | 3 | # Interface: Layout 4 | 5 | A layout describes a set of Video windows that are displayed simultaniously on a display. 6 | 7 | ## Hierarchy 8 | 9 | * **Layout** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Extension](_api_types_.layout.md#optional-readonly-extension) 16 | * [PaneLayout](_api_types_.layout.md#readonly-panelayout) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Extension 21 | 22 | • **Extension**? : *[LayoutExtension](_api_types_.layoutextension.md)* 23 | 24 | *Defined in [api/types.ts:3522](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3522)* 25 | 26 | ___ 27 | 28 | ### `Readonly` PaneLayout 29 | 30 | • **PaneLayout**: *[PaneLayout](_api_types_.panelayout.md)* 31 | 32 | *Defined in [api/types.ts:3521](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3521)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.layoutextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [LayoutExtension](_api_types_.layoutextension.md) 2 | 3 | # Interface: LayoutExtension 4 | 5 | ## Hierarchy 6 | 7 | * **LayoutExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.layoutoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [LayoutOptionsExtension](_api_types_.layoutoptionsextension.md) 2 | 3 | # Interface: LayoutOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **LayoutOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.lensoffset.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [LensOffset](_api_types_.lensoffset.md) 2 | 3 | # Interface: LensOffset 4 | 5 | Optional horizontal offset of the lens center in normalized coordinates. 6 | 7 | ## Hierarchy 8 | 9 | * **LensOffset** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.locallocation.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [LocalLocation](_api_types_.locallocation.md) 2 | 3 | # Interface: LocalLocation 4 | 5 | East west location as angle. 6 | 7 | ## Hierarchy 8 | 9 | * **LocalLocation** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.localorientation.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [LocalOrientation](_api_types_.localorientation.md) 2 | 3 | # Interface: LocalOrientation 4 | 5 | Rotation around the y axis. 6 | 7 | ## Hierarchy 8 | 9 | * **LocalOrientation** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.maximumnumberofosds.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MaximumNumberOfOSDs](_api_types_.maximumnumberofosds.md) 2 | 3 | # Interface: MaximumNumberOfOSDs 4 | 5 | ## Hierarchy 6 | 7 | * **MaximumNumberOfOSDs** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.mediacapabilitiesextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MediaCapabilitiesExtension](_api_types_.mediacapabilitiesextension.md) 2 | 3 | # Interface: MediaCapabilitiesExtension 4 | 5 | ## Hierarchy 6 | 7 | * **MediaCapabilitiesExtension** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [ProfileCapabilities](_api_types_.mediacapabilitiesextension.md#readonly-profilecapabilities) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` ProfileCapabilities 18 | 19 | • **ProfileCapabilities**: *[ProfileCapabilities](_api_types_.profilecapabilities.md)* 20 | 21 | *Defined in [api/types.ts:1732](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1732)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.messagedescriptionextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MessageDescriptionExtension](_api_types_.messagedescriptionextension.md) 2 | 3 | # Interface: MessageDescriptionExtension 4 | 5 | ## Hierarchy 6 | 7 | * **MessageDescriptionExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.messageextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MessageExtension](_api_types_.messageextension.md) 2 | 3 | # Interface: MessageExtension 4 | 5 | ## Hierarchy 6 | 7 | * **MessageExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.metadataconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MetadataConfigurationExtension](_api_types_.metadataconfigurationextension.md) 2 | 3 | # Interface: MetadataConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **MetadataConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.metadataconfigurationoptionsextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MetadataConfigurationOptionsExtension2](_api_types_.metadataconfigurationoptionsextension2.md) 2 | 3 | # Interface: MetadataConfigurationOptionsExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **MetadataConfigurationOptionsExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.metadatafilter.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MetadataFilter](_api_types_.metadatafilter.md) 2 | 3 | # Interface: MetadataFilter 4 | 5 | ## Hierarchy 6 | 7 | * **MetadataFilter** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [MetadataStreamFilter](_api_types_.metadatafilter.md#readonly-metadatastreamfilter) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` MetadataStreamFilter 18 | 19 | • **MetadataStreamFilter**: *[XPathExpression](../modules/_api_types_.md#xpathexpression)* 20 | 21 | *Defined in [api/types.ts:3658](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3658)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.metadatainput.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MetadataInput](_api_types_.metadatainput.md) 2 | 3 | # Interface: MetadataInput 4 | 5 | ## Hierarchy 6 | 7 | * **MetadataInput** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Extension](_api_types_.metadatainput.md#optional-readonly-extension) 14 | * [MetadataConfig](_api_types_.metadatainput.md#optional-readonly-metadataconfig) 15 | 16 | ## Properties 17 | 18 | ### `Optional` `Readonly` Extension 19 | 20 | • **Extension**? : *[MetadataInputExtension](_api_types_.metadatainputextension.md)* 21 | 22 | *Defined in [api/types.ts:4041](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4041)* 23 | 24 | ___ 25 | 26 | ### `Optional` `Readonly` MetadataConfig 27 | 28 | • **MetadataConfig**? : *[Config](_api_types_.config.md)* 29 | 30 | *Defined in [api/types.ts:4040](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4040)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.metadatainputextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MetadataInputExtension](_api_types_.metadatainputextension.md) 2 | 3 | # Interface: MetadataInputExtension 4 | 5 | ## Hierarchy 6 | 7 | * **MetadataInputExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.misccapabilities.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MiscCapabilities](_api_types_.misccapabilities.md) 2 | 3 | # Interface: MiscCapabilities 4 | 5 | Lists of commands supported by SendAuxiliaryCommand. 6 | 7 | ## Hierarchy 8 | 9 | * **MiscCapabilities** 10 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.motionexpression.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MotionExpression](_api_types_.motionexpression.md) 2 | 3 | # Interface: MotionExpression 4 | 5 | Motion Expression data structure contains motion expression which is based on Scene Descriptor schema with XPATH syntax. The Type argument could allow introduction of different dialects 6 | 7 | ## Hierarchy 8 | 9 | * **MotionExpression** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Expression](_api_types_.motionexpression.md#readonly-expression) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Expression 20 | 21 | • **Expression**: *string* 22 | 23 | *Defined in [api/types.ts:3480](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3480)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.motionexpressionconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MotionExpressionConfiguration](_api_types_.motionexpressionconfiguration.md) 2 | 3 | # Interface: MotionExpressionConfiguration 4 | 5 | Contains Rule MotionExpression configuration 6 | 7 | ## Hierarchy 8 | 9 | * **MotionExpressionConfiguration** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [MotionExpression](_api_types_.motionexpressionconfiguration.md#readonly-motionexpression) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` MotionExpression 20 | 21 | • **MotionExpression**: *[MotionExpression](_api_types_.motionexpression.md)* 22 | 23 | *Defined in [api/types.ts:3487](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3487)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.mpeg4options2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Mpeg4Options2](_api_types_.mpeg4options2.md) 2 | 3 | # Interface: Mpeg4Options2 4 | 5 | Supported range of encoded bitrate in kbps. 6 | 7 | ## Hierarchy 8 | 9 | * **Mpeg4Options2** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [BitrateRange](_api_types_.mpeg4options2.md#readonly-bitraterange) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` BitrateRange 20 | 21 | • **BitrateRange**: *[IntRange](_api_types_.intrange.md)* 22 | 23 | *Defined in [api/types.ts:818](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L818)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.multipletopicsspecifiedfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [MultipleTopicsSpecifiedFaultType](_api_types_.multipletopicsspecifiedfaulttype.md) 2 | 3 | # Interface: MultipleTopicsSpecifiedFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **MultipleTopicsSpecifiedFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.networkcapabilitiesextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkCapabilitiesExtension2](_api_types_.networkcapabilitiesextension2.md) 2 | 3 | # Interface: NetworkCapabilitiesExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **NetworkCapabilitiesExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.networkhostextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkHostExtension](_api_types_.networkhostextension.md) 2 | 3 | # Interface: NetworkHostExtension 4 | 5 | ## Hierarchy 6 | 7 | * **NetworkHostExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.networkinterfaceextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkInterfaceExtension2](_api_types_.networkinterfaceextension2.md) 2 | 3 | # Interface: NetworkInterfaceExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **NetworkInterfaceExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.networkinterfacesetconfigurationextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkInterfaceSetConfigurationExtension2](_api_types_.networkinterfacesetconfigurationextension2.md) 2 | 3 | # Interface: NetworkInterfaceSetConfigurationExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **NetworkInterfaceSetConfigurationExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.networkprotocolextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkProtocolExtension](_api_types_.networkprotocolextension.md) 2 | 3 | # Interface: NetworkProtocolExtension 4 | 5 | ## Hierarchy 6 | 7 | * **NetworkProtocolExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.networkzeroconfigurationextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NetworkZeroConfigurationExtension2](_api_types_.networkzeroconfigurationextension2.md) 2 | 3 | # Interface: NetworkZeroConfigurationExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **NetworkZeroConfigurationExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.nocurrentmessageontopicfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NoCurrentMessageOnTopicFaultType](_api_types_.nocurrentmessageontopicfaulttype.md) 2 | 3 | # Interface: NoCurrentMessageOnTopicFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **NoCurrentMessageOnTopicFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.noisereduction.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NoiseReduction](_api_types_.noisereduction.md) 2 | 3 | # Interface: NoiseReduction 4 | 5 | Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. 6 | 7 | ## Hierarchy 8 | 9 | * **NoiseReduction** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Level](_api_types_.noisereduction.md#readonly-level) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Level 20 | 21 | • **Level**: *number* 22 | 23 | *Defined in [api/types.ts:3042](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3042)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.noisereductionoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NoiseReductionOptions](_api_types_.noisereductionoptions.md) 2 | 3 | # Interface: NoiseReductionOptions 4 | 5 | Indicates whether or not support Level parameter for NoiseReduction. 6 | 7 | ## Hierarchy 8 | 9 | * **NoiseReductionOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Level](_api_types_.noisereductionoptions.md#readonly-level) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Level 20 | 21 | • **Level**: *boolean* 22 | 23 | *Defined in [api/types.ts:3297](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3297)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.notificationmessageholdertype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NotificationMessageHolderType](_api_types_.notificationmessageholdertype.md) 2 | 3 | # Interface: NotificationMessageHolderType 4 | 5 | ## Hierarchy 6 | 7 | * **NotificationMessageHolderType** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Message](_api_types_.notificationmessageholdertype.md#readonly-message) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` Message 18 | 19 | • **Message**: *any* 20 | 21 | *Defined in [api/types.ts:147](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L147)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.notifymessagenotsupportedfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NotifyMessageNotSupportedFaultType](_api_types_.notifymessagenotsupportedfaulttype.md) 2 | 3 | # Interface: NotifyMessageNotSupportedFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **NotifyMessageNotSupportedFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ntpinformationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [NTPInformationExtension](_api_types_.ntpinformationextension.md) 2 | 3 | # Interface: NTPInformationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **NTPInformationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.onvifversion.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OnvifVersion](_api_types_.onvifversion.md) 2 | 3 | # Interface: OnvifVersion 4 | 5 | Major version number. 6 | 7 | ## Hierarchy 8 | 9 | * **OnvifVersion** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Major](_api_types_.onvifversion.md#readonly-major) 16 | * [Minor](_api_types_.onvifversion.md#readonly-minor) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Major 21 | 22 | • **Major**: *number* 23 | 24 | *Defined in [api/types.ts:1850](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1850)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Minor 29 | 30 | • **Minor**: *number* 31 | 32 | *Defined in [api/types.ts:1851](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1851)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdcolor.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDColor](_api_types_.osdcolor.md) 2 | 3 | # Interface: OSDColor 4 | 5 | The value range of "Transparent" could be defined by vendors only should follow this rule: the minimum value means non-transparent and the maximum value maens fully transparent. 6 | 7 | ## Hierarchy 8 | 9 | * **OSDColor** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Color](_api_types_.osdcolor.md#readonly-color) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Color 20 | 21 | • **Color**: *[Color](_api_types_.color.md)* 22 | 23 | *Defined in [api/types.ts:4169](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4169)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdcoloroptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDColorOptionsExtension](_api_types_.osdcoloroptionsextension.md) 2 | 3 | # Interface: OSDColorOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDColorOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDConfigurationExtension](_api_types_.osdconfigurationextension.md) 2 | 3 | # Interface: OSDConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdconfigurationoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDConfigurationOptionsExtension](_api_types_.osdconfigurationoptionsextension.md) 2 | 3 | # Interface: OSDConfigurationOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDConfigurationOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdimgconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDImgConfiguration](_api_types_.osdimgconfiguration.md) 2 | 3 | # Interface: OSDImgConfiguration 4 | 5 | The URI of the image which to be displayed. 6 | 7 | ## Hierarchy 8 | 9 | * **OSDImgConfiguration** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Extension](_api_types_.osdimgconfiguration.md#optional-readonly-extension) 16 | * [ImgPath](_api_types_.osdimgconfiguration.md#readonly-imgpath) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Extension 21 | 22 | • **Extension**? : *[OSDImgConfigurationExtension](_api_types_.osdimgconfigurationextension.md)* 23 | 24 | *Defined in [api/types.ts:4204](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4204)* 25 | 26 | ___ 27 | 28 | ### `Readonly` ImgPath 29 | 30 | • **ImgPath**: *string* 31 | 32 | *Defined in [api/types.ts:4203](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4203)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdimgconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDImgConfigurationExtension](_api_types_.osdimgconfigurationextension.md) 2 | 3 | # Interface: OSDImgConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDImgConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdimgoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDImgOptions](_api_types_.osdimgoptions.md) 2 | 3 | # Interface: OSDImgOptions 4 | 5 | List of available image URIs. 6 | 7 | ## Hierarchy 8 | 9 | * **OSDImgOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Extension](_api_types_.osdimgoptions.md#optional-readonly-extension) 16 | * [ImagePath](_api_types_.osdimgoptions.md#readonly-imagepath) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Extension 21 | 22 | • **Extension**? : *[OSDImgOptionsExtension](_api_types_.osdimgoptionsextension.md)* 23 | 24 | *Defined in [api/types.ts:4274](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4274)* 25 | 26 | ___ 27 | 28 | ### `Readonly` ImagePath 29 | 30 | • **ImagePath**: *string* 31 | 32 | *Defined in [api/types.ts:4273](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4273)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdimgoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDImgOptionsExtension](_api_types_.osdimgoptionsextension.md) 2 | 3 | # Interface: OSDImgOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDImgOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdposconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDPosConfigurationExtension](_api_types_.osdposconfigurationextension.md) 2 | 3 | # Interface: OSDPosConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDPosConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdreference.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDReference](_api_types_.osdreference.md) 2 | 3 | # Interface: OSDReference 4 | 5 | ## Hierarchy 6 | 7 | * **OSDReference** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdtextconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDTextConfigurationExtension](_api_types_.osdtextconfigurationextension.md) 2 | 3 | # Interface: OSDTextConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDTextConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.osdtextoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [OSDTextOptionsExtension](_api_types_.osdtextoptionsextension.md) 2 | 3 | # Interface: OSDTextOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **OSDTextOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.panelayout.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PaneLayout](_api_types_.panelayout.md) 2 | 3 | # Interface: PaneLayout 4 | 5 | A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen. 6 | 7 | ## Hierarchy 8 | 9 | * **PaneLayout** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Area](_api_types_.panelayout.md#readonly-area) 16 | * [Pane](_api_types_.panelayout.md#readonly-pane) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Area 21 | 22 | • **Area**: *[Rectangle](_api_types_.rectangle.md)* 23 | 24 | *Defined in [api/types.ts:3514](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3514)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Pane 29 | 30 | • **Pane**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* 31 | 32 | *Defined in [api/types.ts:3513](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3513)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.paneoptionextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PaneOptionExtension](_api_types_.paneoptionextension.md) 2 | 3 | # Interface: PaneOptionExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PaneOptionExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.pantiltlimits.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PanTiltLimits](_api_types_.pantiltlimits.md) 2 | 3 | # Interface: PanTiltLimits 4 | 5 | A range of pan tilt limits. 6 | 7 | ## Hierarchy 8 | 9 | * **PanTiltLimits** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Range](_api_types_.pantiltlimits.md#readonly-range) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Range 20 | 21 | • **Range**: *[Space2DDescription](_api_types_.space2ddescription.md)* 22 | 23 | *Defined in [api/types.ts:2406](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2406)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.pausefailedfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PauseFailedFaultType](_api_types_.pausefailedfaulttype.md) 2 | 3 | # Interface: PauseFailedFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **PauseFailedFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.polygon.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Polygon](_api_types_.polygon.md) 2 | 3 | # Interface: Polygon 4 | 5 | ## Hierarchy 6 | 7 | * **Polygon** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Point](_api_types_.polygon.md#readonly-point) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` Point 18 | 19 | • **Point**: *[Vector](_api_types_.vector.md)* 20 | 21 | *Defined in [api/types.ts:356](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L356)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.polyline.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Polyline](_api_types_.polyline.md) 2 | 3 | # Interface: Polyline 4 | 5 | ## Hierarchy 6 | 7 | * **Polyline** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Point](_api_types_.polyline.md#readonly-point) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` Point 18 | 19 | • **Point**: *[Vector](_api_types_.vector.md)* 20 | 21 | *Defined in [api/types.ts:3364](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3364)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.polylinearray.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PolylineArray](_api_types_.polylinearray.md) 2 | 3 | # Interface: PolylineArray 4 | 5 | Contains array of Polyline 6 | 7 | ## Hierarchy 8 | 9 | * **PolylineArray** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Extension](_api_types_.polylinearray.md#optional-readonly-extension) 16 | * [Segment](_api_types_.polylinearray.md#readonly-segment) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Extension 21 | 22 | • **Extension**? : *[PolylineArrayExtension](_api_types_.polylinearrayextension.md)* 23 | 24 | *Defined in [api/types.ts:3460](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3460)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Segment 29 | 30 | • **Segment**: *[Polyline](_api_types_.polyline.md)* 31 | 32 | *Defined in [api/types.ts:3459](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3459)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.polylinearrayconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PolylineArrayConfiguration](_api_types_.polylinearrayconfiguration.md) 2 | 3 | # Interface: PolylineArrayConfiguration 4 | 5 | Contains PolylineArray configuration data 6 | 7 | ## Hierarchy 8 | 9 | * **PolylineArrayConfiguration** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [PolylineArray](_api_types_.polylinearrayconfiguration.md#readonly-polylinearray) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` PolylineArray 20 | 21 | • **PolylineArray**: *[PolylineArray](_api_types_.polylinearray.md)* 22 | 23 | *Defined in [api/types.ts:3473](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3473)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.polylinearrayextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PolylineArrayExtension](_api_types_.polylinearrayextension.md) 2 | 3 | # Interface: PolylineArrayExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PolylineArrayExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.prefixedipv4address.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PrefixedIPv4Address](_api_types_.prefixedipv4address.md) 2 | 3 | # Interface: PrefixedIPv4Address 4 | 5 | IPv4 address 6 | 7 | ## Hierarchy 8 | 9 | * **PrefixedIPv4Address** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Address](_api_types_.prefixedipv4address.md#readonly-address) 16 | * [PrefixLength](_api_types_.prefixedipv4address.md#readonly-prefixlength) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Address 21 | 22 | • **Address**: *[IPv4Address](../modules/_api_types_.md#ipv4address)* 23 | 24 | *Defined in [api/types.ts:1367](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1367)* 25 | 26 | ___ 27 | 28 | ### `Readonly` PrefixLength 29 | 30 | • **PrefixLength**: *number* 31 | 32 | *Defined in [api/types.ts:1368](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1368)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.prefixedipv6address.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PrefixedIPv6Address](_api_types_.prefixedipv6address.md) 2 | 3 | # Interface: PrefixedIPv6Address 4 | 5 | IPv6 address 6 | 7 | ## Hierarchy 8 | 9 | * **PrefixedIPv6Address** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Address](_api_types_.prefixedipv6address.md#readonly-address) 16 | * [PrefixLength](_api_types_.prefixedipv6address.md#readonly-prefixlength) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Address 21 | 22 | • **Address**: *[IPv6Address](../modules/_api_types_.md#ipv6address)* 23 | 24 | *Defined in [api/types.ts:1375](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1375)* 25 | 26 | ___ 27 | 28 | ### `Readonly` PrefixLength 29 | 30 | • **PrefixLength**: *number* 31 | 32 | *Defined in [api/types.ts:1376](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1376)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.profilecapabilities.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ProfileCapabilities](_api_types_.profilecapabilities.md) 2 | 3 | # Interface: ProfileCapabilities 4 | 5 | Maximum number of profiles. 6 | 7 | ## Hierarchy 8 | 9 | * **ProfileCapabilities** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [MaximumNumberOfProfiles](_api_types_.profilecapabilities.md#readonly-maximumnumberofprofiles) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` MaximumNumberOfProfiles 20 | 21 | • **MaximumNumberOfProfiles**: *number* 22 | 23 | *Defined in [api/types.ts:1755](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1755)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.profileextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ProfileExtension2](_api_types_.profileextension2.md) 2 | 3 | # Interface: ProfileExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **ProfileExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.profilestatus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ProfileStatus](_api_types_.profilestatus.md) 2 | 3 | # Interface: ProfileStatus 4 | 5 | ## Hierarchy 6 | 7 | * **ProfileStatus** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [ActiveConnections](_api_types_.profilestatus.md#optional-readonly-activeconnections) 14 | * [Extension](_api_types_.profilestatus.md#optional-readonly-extension) 15 | 16 | ## Properties 17 | 18 | ### `Optional` `Readonly` ActiveConnections 19 | 20 | • **ActiveConnections**? : *[ActiveConnection](_api_types_.activeconnection.md)* 21 | 22 | *Defined in [api/types.ts:4129](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4129)* 23 | 24 | ___ 25 | 26 | ### `Optional` `Readonly` Extension 27 | 28 | • **Extension**? : *[ProfileStatusExtension](_api_types_.profilestatusextension.md)* 29 | 30 | *Defined in [api/types.ts:4130](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4130)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.profilestatusextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ProfileStatusExtension](_api_types_.profilestatusextension.md) 2 | 3 | # Interface: ProfileStatusExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ProfileStatusExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptcontroldirectionextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTControlDirectionExtension](_api_types_.ptcontroldirectionextension.md) 2 | 3 | # Interface: PTControlDirectionExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTControlDirectionExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptcontroldirectionoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTControlDirectionOptionsExtension](_api_types_.ptcontroldirectionoptionsextension.md) 2 | 3 | # Interface: PTControlDirectionOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTControlDirectionOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzcapabilities.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZCapabilities](_api_types_.ptzcapabilities.md) 2 | 3 | # Interface: PTZCapabilities 4 | 5 | PTZ service URI. 6 | 7 | ## Hierarchy 8 | 9 | * **PTZCapabilities** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [XAddr](_api_types_.ptzcapabilities.md#readonly-xaddr) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` XAddr 20 | 21 | • **XAddr**: *string* 22 | 23 | *Defined in [api/types.ts:1865](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1865)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzconfigurationextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZConfigurationExtension2](_api_types_.ptzconfigurationextension2.md) 2 | 3 | # Interface: PTZConfigurationExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **PTZConfigurationExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzconfigurationoptions2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZConfigurationOptions2](_api_types_.ptzconfigurationoptions2.md) 2 | 3 | # Interface: PTZConfigurationOptions2 4 | 5 | ## Hierarchy 6 | 7 | * **PTZConfigurationOptions2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzfilter.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZFilter](_api_types_.ptzfilter.md) 2 | 3 | # Interface: PTZFilter 4 | 5 | True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN) 6 | 7 | ## Hierarchy 8 | 9 | * **PTZFilter** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Position](_api_types_.ptzfilter.md#readonly-position) 16 | * [Status](_api_types_.ptzfilter.md#readonly-status) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Position 21 | 22 | • **Position**: *boolean* 23 | 24 | *Defined in [api/types.ts:975](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L975)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Status 29 | 30 | • **Status**: *boolean* 31 | 32 | *Defined in [api/types.ts:974](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L974)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzmovestatus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZMoveStatus](_api_types_.ptzmovestatus.md) 2 | 3 | # Interface: PTZMoveStatus 4 | 5 | ## Hierarchy 6 | 7 | * **PTZMoveStatus** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [PanTilt](_api_types_.ptzmovestatus.md#optional-readonly-pantilt) 14 | * [Zoom](_api_types_.ptzmovestatus.md#optional-readonly-zoom) 15 | 16 | ## Properties 17 | 18 | ### `Optional` `Readonly` PanTilt 19 | 20 | • **PanTilt**? : *[MoveStatus](../enums/_api_types_.movestatus.md)* 21 | 22 | *Defined in [api/types.ts:336](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L336)* 23 | 24 | ___ 25 | 26 | ### `Optional` `Readonly` Zoom 27 | 28 | • **Zoom**? : *[MoveStatus](../enums/_api_types_.movestatus.md)* 29 | 30 | *Defined in [api/types.ts:337](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L337)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptznodeextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZNodeExtension2](_api_types_.ptznodeextension2.md) 2 | 3 | # Interface: PTZNodeExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **PTZNodeExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpreset.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPreset](_api_types_.ptzpreset.md) 2 | 3 | # Interface: PTZPreset 4 | 5 | A list of preset position name. 6 | 7 | ## Hierarchy 8 | 9 | * **PTZPreset** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Name](_api_types_.ptzpreset.md#optional-readonly-name) 16 | * [PTZPosition](_api_types_.ptzpreset.md#optional-readonly-ptzposition) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Name 21 | 22 | • **Name**? : *[Name](_api_types_.ptzpreset.md#optional-readonly-name)* 23 | 24 | *Defined in [api/types.ts:2477](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2477)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` PTZPosition 29 | 30 | • **PTZPosition**? : *[PTZVector](_api_types_.ptzvector.md)* 31 | 32 | *Defined in [api/types.ts:2478](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2478)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettourextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourExtension](_api_types_.ptzpresettourextension.md) 2 | 3 | # Interface: PTZPresetTourExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettourpresetdetailoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourPresetDetailOptionsExtension](_api_types_.ptzpresettourpresetdetailoptionsextension.md) 2 | 3 | # Interface: PTZPresetTourPresetDetailOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourPresetDetailOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettourspotextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourSpotExtension](_api_types_.ptzpresettourspotextension.md) 2 | 3 | # Interface: PTZPresetTourSpotExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourSpotExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettourstartingconditionextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourStartingConditionExtension](_api_types_.ptzpresettourstartingconditionextension.md) 2 | 3 | # Interface: PTZPresetTourStartingConditionExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourStartingConditionExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettourstartingconditionoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourStartingConditionOptionsExtension](_api_types_.ptzpresettourstartingconditionoptionsextension.md) 2 | 3 | # Interface: PTZPresetTourStartingConditionOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourStartingConditionOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettourstatusextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourStatusExtension](_api_types_.ptzpresettourstatusextension.md) 2 | 3 | # Interface: PTZPresetTourStatusExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourStatusExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettoursupportedextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourSupportedExtension](_api_types_.ptzpresettoursupportedextension.md) 2 | 3 | # Interface: PTZPresetTourSupportedExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourSupportedExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzpresettourtypeextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZPresetTourTypeExtension](_api_types_.ptzpresettourtypeextension.md) 2 | 3 | # Interface: PTZPresetTourTypeExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZPresetTourTypeExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzspacesextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZSpacesExtension](_api_types_.ptzspacesextension.md) 2 | 3 | # Interface: PTZSpacesExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZSpacesExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzstatusfilteroptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZStatusFilterOptionsExtension](_api_types_.ptzstatusfilteroptionsextension.md) 2 | 3 | # Interface: PTZStatusFilterOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **PTZStatusFilterOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ptzvector.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [PTZVector](_api_types_.ptzvector.md) 2 | 3 | # Interface: PTZVector 4 | 5 | Pan and tilt position. The x component corresponds to pan and the y component to tilt. 6 | 7 | ## Hierarchy 8 | 9 | * **PTZVector** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [PanTilt](_api_types_.ptzvector.md#optional-readonly-pantilt) 16 | * [Zoom](_api_types_.ptzvector.md#optional-readonly-zoom) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` PanTilt 21 | 22 | • **PanTilt**? : *[Vector2D](_api_types_.vector2d.md)* 23 | 24 | *Defined in [api/types.ts:315](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L315)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` Zoom 29 | 30 | • **Zoom**? : *[Vector1D](_api_types_.vector1d.md)* 31 | 32 | *Defined in [api/types.ts:316](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L316)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.queryexpressiontype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [QueryExpressionType](_api_types_.queryexpressiontype.md) 2 | 3 | # Interface: QueryExpressionType 4 | 5 | ## Hierarchy 6 | 7 | * **QueryExpressionType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.realtimestreamingcapabilitiesextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RealTimeStreamingCapabilitiesExtension](_api_types_.realtimestreamingcapabilitiesextension.md) 2 | 3 | # Interface: RealTimeStreamingCapabilitiesExtension 4 | 5 | ## Hierarchy 6 | 7 | * **RealTimeStreamingCapabilitiesExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.receiver.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Receiver](_api_types_.receiver.md) 2 | 3 | # Interface: Receiver 4 | 5 | Description of a receiver, including its token and configuration. 6 | 7 | ## Hierarchy 8 | 9 | * **Receiver** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Configuration](_api_types_.receiver.md#readonly-configuration) 16 | * [Token](_api_types_.receiver.md#readonly-token) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Configuration 21 | 22 | • **Configuration**: *[ReceiverConfiguration](_api_types_.receiverconfiguration.md)* 23 | 24 | *Defined in [api/types.ts:3575](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3575)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Token 29 | 30 | • **Token**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* 31 | 32 | *Defined in [api/types.ts:3574](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3574)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.recordingjobconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RecordingJobConfigurationExtension](_api_types_.recordingjobconfigurationextension.md) 2 | 3 | # Interface: RecordingJobConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **RecordingJobConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.recordingjobsourceextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RecordingJobSourceExtension](_api_types_.recordingjobsourceextension.md) 2 | 3 | # Interface: RecordingJobSourceExtension 4 | 5 | ## Hierarchy 6 | 7 | * **RecordingJobSourceExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.recordingjobstateinformationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RecordingJobStateInformationExtension](_api_types_.recordingjobstateinformationextension.md) 2 | 3 | # Interface: RecordingJobStateInformationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **RecordingJobStateInformationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.recordingjobstatetracks.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RecordingJobStateTracks](_api_types_.recordingjobstatetracks.md) 2 | 3 | # Interface: RecordingJobStateTracks 4 | 5 | ## Hierarchy 6 | 7 | * **RecordingJobStateTracks** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Track](_api_types_.recordingjobstatetracks.md#optional-readonly-track) 14 | 15 | ## Properties 16 | 17 | ### `Optional` `Readonly` Track 18 | 19 | • **Track**? : *[RecordingJobStateTrack](_api_types_.recordingjobstatetrack.md)* 20 | 21 | *Defined in [api/types.ts:3939](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3939)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.rectangle.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Rectangle](_api_types_.rectangle.md) 2 | 3 | # Interface: Rectangle 4 | 5 | ## Hierarchy 6 | 7 | * **Rectangle** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.relativefocus.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RelativeFocus](_api_types_.relativefocus.md) 2 | 3 | # Interface: RelativeFocus 4 | 5 | Distance parameter for the relative focus control. 6 | 7 | ## Hierarchy 8 | 9 | * **RelativeFocus** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Distance](_api_types_.relativefocus.md#readonly-distance) 16 | * [Speed](_api_types_.relativefocus.md#optional-readonly-speed) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Distance 21 | 22 | • **Distance**: *number* 23 | 24 | *Defined in [api/types.ts:2800](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2800)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` Speed 29 | 30 | • **Speed**? : *undefined | number* 31 | 32 | *Defined in [api/types.ts:2801](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2801)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.relativefocusoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RelativeFocusOptions](_api_types_.relativefocusoptions.md) 2 | 3 | # Interface: RelativeFocusOptions 4 | 5 | Valid ranges of the distance. 6 | 7 | ## Hierarchy 8 | 9 | * **RelativeFocusOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Distance](_api_types_.relativefocusoptions.md#readonly-distance) 16 | * [Speed](_api_types_.relativefocusoptions.md#readonly-speed) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Distance 21 | 22 | • **Distance**: *[FloatRange](_api_types_.floatrange.md)* 23 | 24 | *Defined in [api/types.ts:2838](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2838)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Speed 29 | 30 | • **Speed**: *[FloatRange](_api_types_.floatrange.md)* 31 | 32 | *Defined in [api/types.ts:2839](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2839)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.relativefocusoptions20.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RelativeFocusOptions20](_api_types_.relativefocusoptions20.md) 2 | 3 | # Interface: RelativeFocusOptions20 4 | 5 | Valid ranges of the distance. 6 | 7 | ## Hierarchy 8 | 9 | * **RelativeFocusOptions20** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Distance](_api_types_.relativefocusoptions20.md#readonly-distance) 16 | * [Speed](_api_types_.relativefocusoptions20.md#optional-readonly-speed) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Distance 21 | 22 | • **Distance**: *[FloatRange](_api_types_.floatrange.md)* 23 | 24 | *Defined in [api/types.ts:3185](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3185)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` Speed 29 | 30 | • **Speed**? : *[FloatRange](_api_types_.floatrange.md)* 31 | 32 | *Defined in [api/types.ts:3186](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3186)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.relayoutput.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RelayOutput](_api_types_.relayoutput.md) 2 | 3 | # Interface: RelayOutput 4 | 5 | ## Hierarchy 6 | 7 | * **RelayOutput** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Properties](_api_types_.relayoutput.md#readonly-properties) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` Properties 18 | 19 | • **Properties**: *[RelayOutputSettings](_api_types_.relayoutputsettings.md)* 20 | 21 | *Defined in [api/types.ts:2220](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2220)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.replaycapabilities.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ReplayCapabilities](_api_types_.replaycapabilities.md) 2 | 3 | # Interface: ReplayCapabilities 4 | 5 | The address of the replay service. 6 | 7 | ## Hierarchy 8 | 9 | * **ReplayCapabilities** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [XAddr](_api_types_.replaycapabilities.md#readonly-xaddr) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` XAddr 20 | 21 | • **XAddr**: *string* 22 | 23 | *Defined in [api/types.ts:1912](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1912)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.replayconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ReplayConfiguration](_api_types_.replayconfiguration.md) 2 | 3 | # Interface: ReplayConfiguration 4 | 5 | Configuration parameters for the replay service. 6 | 7 | ## Hierarchy 8 | 9 | * **ReplayConfiguration** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [SessionTimeout](_api_types_.replayconfiguration.md#readonly-sessiontimeout) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` SessionTimeout 20 | 21 | • **SessionTimeout**: *string* 22 | 23 | *Defined in [api/types.ts:3966](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3966)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.resumefailedfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ResumeFailedFaultType](_api_types_.resumefailedfaulttype.md) 2 | 3 | # Interface: ResumeFailedFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **ResumeFailedFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.reverse.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Reverse](_api_types_.reverse.md) 2 | 3 | # Interface: Reverse 4 | 5 | Parameter to enable/disable Reverse feature. 6 | 7 | ## Hierarchy 8 | 9 | * **Reverse** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Mode](_api_types_.reverse.md#readonly-mode) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Mode 20 | 21 | • **Mode**: *[ReverseMode](../enums/_api_types_.reversemode.md)* 22 | 23 | *Defined in [api/types.ts:2336](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2336)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.reverseoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ReverseOptionsExtension](_api_types_.reverseoptionsextension.md) 2 | 3 | # Interface: ReverseOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ReverseOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.rotateextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RotateExtension](_api_types_.rotateextension.md) 2 | 3 | # Interface: RotateExtension 4 | 5 | ## Hierarchy 6 | 7 | * **RotateExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.rotateoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RotateOptionsExtension](_api_types_.rotateoptionsextension.md) 2 | 3 | # Interface: RotateOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **RotateOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.ruleengineconfigurationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [RuleEngineConfigurationExtension](_api_types_.ruleengineconfigurationextension.md) 2 | 3 | # Interface: RuleEngineConfigurationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **RuleEngineConfigurationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.scope.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Scope](_api_types_.scope.md) 2 | 3 | # Interface: Scope 4 | 5 | Indicates if the scope is fixed or configurable. 6 | 7 | ## Hierarchy 8 | 9 | * **Scope** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [ScopeDef](_api_types_.scope.md#readonly-scopedef) 16 | * [ScopeItem](_api_types_.scope.md#readonly-scopeitem) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` ScopeDef 21 | 22 | • **ScopeDef**: *[ScopeDefinition](../enums/_api_types_.scopedefinition.md)* 23 | 24 | *Defined in [api/types.ts:1211](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1211)* 25 | 26 | ___ 27 | 28 | ### `Readonly` ScopeItem 29 | 30 | • **ScopeItem**: *string* 31 | 32 | *Defined in [api/types.ts:1212](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1212)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.searchcapabilities.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SearchCapabilities](_api_types_.searchcapabilities.md) 2 | 3 | # Interface: SearchCapabilities 4 | 5 | ## Hierarchy 6 | 7 | * **SearchCapabilities** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [MetadataSearch](_api_types_.searchcapabilities.md#readonly-metadatasearch) 14 | * [XAddr](_api_types_.searchcapabilities.md#readonly-xaddr) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` MetadataSearch 19 | 20 | • **MetadataSearch**: *boolean* 21 | 22 | *Defined in [api/types.ts:1905](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1905)* 23 | 24 | ___ 25 | 26 | ### `Readonly` XAddr 27 | 28 | • **XAddr**: *string* 29 | 30 | *Defined in [api/types.ts:1904](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1904)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.searchscopeextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SearchScopeExtension](_api_types_.searchscopeextension.md) 2 | 3 | # Interface: SearchScopeExtension 4 | 5 | ## Hierarchy 6 | 7 | * **SearchScopeExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.sourceidentificationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SourceIdentificationExtension](_api_types_.sourceidentificationextension.md) 2 | 3 | # Interface: SourceIdentificationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **SourceIdentificationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.sourcereference.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SourceReference](_api_types_.sourcereference.md) 2 | 3 | # Interface: SourceReference 4 | 5 | ## Hierarchy 6 | 7 | * **SourceReference** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Token](_api_types_.sourcereference.md#readonly-token) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` Token 18 | 19 | • **Token**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* 20 | 21 | *Defined in [api/types.ts:3603](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3603)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.space1ddescription.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Space1DDescription](_api_types_.space1ddescription.md) 2 | 3 | # Interface: Space1DDescription 4 | 5 | A URI of coordinate systems. 6 | 7 | ## Hierarchy 8 | 9 | * **Space1DDescription** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [URI](_api_types_.space1ddescription.md#readonly-uri) 16 | * [XRange](_api_types_.space1ddescription.md#readonly-xrange) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` URI 21 | 22 | • **URI**: *string* 23 | 24 | *Defined in [api/types.ts:2459](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2459)* 25 | 26 | ___ 27 | 28 | ### `Readonly` XRange 29 | 30 | • **XRange**: *[FloatRange](_api_types_.floatrange.md)* 31 | 32 | *Defined in [api/types.ts:2460](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2460)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.storageconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [StorageConfiguration](_api_types_.storageconfiguration.md) 2 | 3 | # Interface: StorageConfiguration 4 | 5 | ## Hierarchy 6 | 7 | * **StorageConfiguration** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Data](_api_types_.storageconfiguration.md#readonly-data) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` Data 18 | 19 | • **Data**: *[StorageConfigurationData](_api_types_.storageconfigurationdata.md)* 20 | 21 | *Defined in [api/types.ts:4499](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L4499)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.storagereferencepathextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [StorageReferencePathExtension](_api_types_.storagereferencepathextension.md) 2 | 3 | # Interface: StorageReferencePathExtension 4 | 5 | ## Hierarchy 6 | 7 | * **StorageReferencePathExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.streamsetup.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [StreamSetup](_api_types_.streamsetup.md) 2 | 3 | # Interface: StreamSetup 4 | 5 | Defines if a multicast or unicast stream is requested 6 | 7 | ## Hierarchy 8 | 9 | * **StreamSetup** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Stream](_api_types_.streamsetup.md#readonly-stream) 16 | * [Transport](_api_types_.streamsetup.md#readonly-transport) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Stream 21 | 22 | • **Stream**: *[StreamType](../enums/_api_types_.streamtype.md)* 23 | 24 | *Defined in [api/types.ts:1185](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1185)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Transport 29 | 30 | • **Transport**: *[Transport](_api_types_.transport.md)* 31 | 32 | *Defined in [api/types.ts:1186](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1186)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.subscribecreationfailedfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SubscribeCreationFailedFaultType](_api_types_.subscribecreationfailedfaulttype.md) 2 | 3 | # Interface: SubscribeCreationFailedFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **SubscribeCreationFailedFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.subscriptionpolicytype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SubscriptionPolicyType](_api_types_.subscriptionpolicytype.md) 2 | 3 | # Interface: SubscriptionPolicyType 4 | 5 | ## Hierarchy 6 | 7 | * **SubscriptionPolicyType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.supportedanalyticsmodulesextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SupportedAnalyticsModulesExtension](_api_types_.supportedanalyticsmodulesextension.md) 2 | 3 | # Interface: SupportedAnalyticsModulesExtension 4 | 5 | ## Hierarchy 6 | 7 | * **SupportedAnalyticsModulesExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.supportedrulesextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SupportedRulesExtension](_api_types_.supportedrulesextension.md) 2 | 3 | # Interface: SupportedRulesExtension 4 | 5 | ## Hierarchy 6 | 7 | * **SupportedRulesExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.supportinformation.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SupportInformation](_api_types_.supportinformation.md) 2 | 3 | # Interface: SupportInformation 4 | 5 | The support information as attachment data. 6 | 7 | ## Hierarchy 8 | 9 | * **SupportInformation** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Binary](_api_types_.supportinformation.md#optional-readonly-binary) 16 | * [String](_api_types_.supportinformation.md#optional-readonly-string) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Binary 21 | 22 | • **Binary**? : *[AttachmentData](_api_types_.attachmentdata.md)* 23 | 24 | *Defined in [api/types.ts:1954](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1954)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` String 29 | 30 | • **String**? : *undefined | string* 31 | 32 | *Defined in [api/types.ts:1955](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1955)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.systemcapabilitiesextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SystemCapabilitiesExtension2](_api_types_.systemcapabilitiesextension2.md) 2 | 3 | # Interface: SystemCapabilitiesExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **SystemCapabilitiesExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.systemdatetimeextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SystemDateTimeExtension](_api_types_.systemdatetimeextension.md) 2 | 3 | # Interface: SystemDateTimeExtension 4 | 5 | ## Hierarchy 6 | 7 | * **SystemDateTimeExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.systemlog.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SystemLog](_api_types_.systemlog.md) 2 | 3 | # Interface: SystemLog 4 | 5 | The log information as attachment data. 6 | 7 | ## Hierarchy 8 | 9 | * **SystemLog** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Binary](_api_types_.systemlog.md#optional-readonly-binary) 16 | * [String](_api_types_.systemlog.md#optional-readonly-string) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Binary 21 | 22 | • **Binary**? : *[AttachmentData](_api_types_.attachmentdata.md)* 23 | 24 | *Defined in [api/types.ts:1946](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1946)* 25 | 26 | ___ 27 | 28 | ### `Optional` `Readonly` String 29 | 30 | • **String**? : *undefined | string* 31 | 32 | *Defined in [api/types.ts:1947](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1947)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.systemloguri.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SystemLogUri](_api_types_.systemloguri.md) 2 | 3 | # Interface: SystemLogUri 4 | 5 | ## Hierarchy 6 | 7 | * **SystemLogUri** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Type](_api_types_.systemloguri.md#readonly-type) 14 | * [Uri](_api_types_.systemloguri.md#readonly-uri) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` Type 19 | 20 | • **Type**: *[SystemLogType](../enums/_api_types_.systemlogtype.md)* 21 | 22 | *Defined in [api/types.ts:1990](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1990)* 23 | 24 | ___ 25 | 26 | ### `Readonly` Uri 27 | 28 | • **Uri**: *string* 29 | 30 | *Defined in [api/types.ts:1991](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1991)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.systemlogurilist.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [SystemLogUriList](_api_types_.systemlogurilist.md) 2 | 3 | # Interface: SystemLogUriList 4 | 5 | ## Hierarchy 6 | 7 | * **SystemLogUriList** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [SystemLog](_api_types_.systemlogurilist.md#optional-readonly-systemlog) 14 | 15 | ## Properties 16 | 17 | ### `Optional` `Readonly` SystemLog 18 | 19 | • **SystemLog**? : *[SystemLogUri](_api_types_.systemloguri.md)* 20 | 21 | *Defined in [api/types.ts:1983](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1983)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.tlsconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [TLSConfiguration](_api_types_.tlsconfiguration.md) 2 | 3 | # Interface: TLSConfiguration 4 | 5 | ## Hierarchy 6 | 7 | * **TLSConfiguration** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [CertificateID](_api_types_.tlsconfiguration.md#readonly-certificateid) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` CertificateID 18 | 19 | • **CertificateID**: *string* 20 | 21 | *Defined in [api/types.ts:2192](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2192)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.tonecompensationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ToneCompensationExtension](_api_types_.tonecompensationextension.md) 2 | 3 | # Interface: ToneCompensationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **ToneCompensationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.tonecompensationoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ToneCompensationOptions](_api_types_.tonecompensationoptions.md) 2 | 3 | # Interface: ToneCompensationOptions 4 | 5 | Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type. 6 | 7 | ## Hierarchy 8 | 9 | * **ToneCompensationOptions** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Level](_api_types_.tonecompensationoptions.md#readonly-level) 16 | * [Mode](_api_types_.tonecompensationoptions.md#readonly-mode) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Level 21 | 22 | • **Level**: *boolean* 23 | 24 | *Defined in [api/types.ts:3282](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3282)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Mode 29 | 30 | • **Mode**: *string* 31 | 32 | *Defined in [api/types.ts:3281](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3281)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.topicexpressiondialectunknownfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [TopicExpressionDialectUnknownFaultType](_api_types_.topicexpressiondialectunknownfaulttype.md) 2 | 3 | # Interface: TopicExpressionDialectUnknownFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **TopicExpressionDialectUnknownFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.topicexpressiontype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [TopicExpressionType](_api_types_.topicexpressiontype.md) 2 | 3 | # Interface: TopicExpressionType 4 | 5 | ## Hierarchy 6 | 7 | * **TopicExpressionType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.topicnotsupportedfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [TopicNotSupportedFaultType](_api_types_.topicnotsupportedfaulttype.md) 2 | 3 | # Interface: TopicNotSupportedFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **TopicNotSupportedFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.trackattributesextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [TrackAttributesExtension](_api_types_.trackattributesextension.md) 2 | 3 | # Interface: TrackAttributesExtension 4 | 5 | ## Hierarchy 6 | 7 | * **TrackAttributesExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.transformationextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [TransformationExtension](_api_types_.transformationextension.md) 2 | 3 | # Interface: TransformationExtension 4 | 5 | ## Hierarchy 6 | 7 | * **TransformationExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.unabletocreatepullpointfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [UnableToCreatePullPointFaultType](_api_types_.unabletocreatepullpointfaulttype.md) 2 | 3 | # Interface: UnableToCreatePullPointFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **UnableToCreatePullPointFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.unabletodestroypullpointfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [UnableToDestroyPullPointFaultType](_api_types_.unabletodestroypullpointfaulttype.md) 2 | 3 | # Interface: UnableToDestroyPullPointFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **UnableToDestroyPullPointFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.unabletodestroysubscriptionfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [UnableToDestroySubscriptionFaultType](_api_types_.unabletodestroysubscriptionfaulttype.md) 2 | 3 | # Interface: UnableToDestroySubscriptionFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **UnableToDestroySubscriptionFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.unabletogetmessagesfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [UnableToGetMessagesFaultType](_api_types_.unabletogetmessagesfaulttype.md) 2 | 3 | # Interface: UnableToGetMessagesFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **UnableToGetMessagesFaultType** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.unrecognizedpolicyrequestfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [UnrecognizedPolicyRequestFaultType](_api_types_.unrecognizedpolicyrequestfaulttype.md) 2 | 3 | # Interface: UnrecognizedPolicyRequestFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **UnrecognizedPolicyRequestFaultType** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [UnrecognizedPolicy](_api_types_.unrecognizedpolicyrequestfaulttype.md#optional-readonly-unrecognizedpolicy) 14 | 15 | ## Properties 16 | 17 | ### `Optional` `Readonly` UnrecognizedPolicy 18 | 19 | • **UnrecognizedPolicy**? : *any* 20 | 21 | *Defined in [api/types.ts:203](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L203)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.unsupportedpolicyrequestfaulttype.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [UnsupportedPolicyRequestFaultType](_api_types_.unsupportedpolicyrequestfaulttype.md) 2 | 3 | # Interface: UnsupportedPolicyRequestFaultType 4 | 5 | ## Hierarchy 6 | 7 | * **UnsupportedPolicyRequestFaultType** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [UnsupportedPolicy](_api_types_.unsupportedpolicyrequestfaulttype.md#optional-readonly-unsupportedpolicy) 14 | 15 | ## Properties 16 | 17 | ### `Optional` `Readonly` UnsupportedPolicy 18 | 19 | • **UnsupportedPolicy**? : *any* 20 | 21 | *Defined in [api/types.ts:210](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L210)* 22 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.userextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [UserExtension](_api_types_.userextension.md) 2 | 3 | # Interface: UserExtension 4 | 5 | ## Hierarchy 6 | 7 | * **UserExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.vector.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Vector](_api_types_.vector.md) 2 | 3 | # Interface: Vector 4 | 5 | ## Hierarchy 6 | 7 | * **Vector** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.vector1d.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Vector1D](_api_types_.vector1d.md) 2 | 3 | # Interface: Vector1D 4 | 5 | Zoom coordinate space selector. The following options are defined: 6 | http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace 7 | http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace 8 | http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace 9 | http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace 10 | 11 | ## Hierarchy 12 | 13 | * **Vector1D** 14 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.vector2d.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [Vector2D](_api_types_.vector2d.md) 2 | 3 | # Interface: Vector2D 4 | 5 | Pan/tilt coordinate space selector. The following options are defined: 6 | http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace 7 | http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace 8 | http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace 9 | http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace 10 | 11 | ## Hierarchy 12 | 13 | * **Vector2D** 14 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videodecoderconfigurationoptionsextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoDecoderConfigurationOptionsExtension](_api_types_.videodecoderconfigurationoptionsextension.md) 2 | 3 | # Interface: VideoDecoderConfigurationOptionsExtension 4 | 5 | ## Hierarchy 6 | 7 | * **VideoDecoderConfigurationOptionsExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videoencoderoptionsextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoEncoderOptionsExtension2](_api_types_.videoencoderoptionsextension2.md) 2 | 3 | # Interface: VideoEncoderOptionsExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **VideoEncoderOptionsExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videooutputconfiguration.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoOutputConfiguration](_api_types_.videooutputconfiguration.md) 2 | 3 | # Interface: VideoOutputConfiguration 4 | 5 | Token of the Video Output the configuration applies to 6 | 7 | ## Hierarchy 8 | 9 | * **VideoOutputConfiguration** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [OutputToken](_api_types_.videooutputconfiguration.md#readonly-outputtoken) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` OutputToken 20 | 21 | • **OutputToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* 22 | 23 | *Defined in [api/types.ts:1046](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L1046)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videooutputconfigurationoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoOutputConfigurationOptions](_api_types_.videooutputconfigurationoptions.md) 2 | 3 | # Interface: VideoOutputConfigurationOptions 4 | 5 | ## Hierarchy 6 | 7 | * **VideoOutputConfigurationOptions** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videooutputextension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoOutputExtension](_api_types_.videooutputextension.md) 2 | 3 | # Interface: VideoOutputExtension 4 | 5 | ## Hierarchy 6 | 7 | * **VideoOutputExtension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videoratecontrol2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoRateControl2](_api_types_.videoratecontrol2.md) 2 | 3 | # Interface: VideoRateControl2 4 | 5 | Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations. 6 | 7 | ## Hierarchy 8 | 9 | * **VideoRateControl2** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [BitrateLimit](_api_types_.videoratecontrol2.md#readonly-bitratelimit) 16 | * [FrameRateLimit](_api_types_.videoratecontrol2.md#readonly-frameratelimit) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` BitrateLimit 21 | 22 | • **BitrateLimit**: *number* 23 | 24 | *Defined in [api/types.ts:863](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L863)* 25 | 26 | ___ 27 | 28 | ### `Readonly` FrameRateLimit 29 | 30 | • **FrameRateLimit**: *number* 31 | 32 | *Defined in [api/types.ts:862](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L862)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videoresolution.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoResolution](_api_types_.videoresolution.md) 2 | 3 | # Interface: VideoResolution 4 | 5 | Number of the columns of the Video image. 6 | 7 | ## Hierarchy 8 | 9 | * **VideoResolution** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Height](_api_types_.videoresolution.md#readonly-height) 16 | * [Width](_api_types_.videoresolution.md#readonly-width) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Height 21 | 22 | • **Height**: *number* 23 | 24 | *Defined in [api/types.ts:732](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L732)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Width 29 | 30 | • **Width**: *number* 31 | 32 | *Defined in [api/types.ts:731](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L731)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videoresolution2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoResolution2](_api_types_.videoresolution2.md) 2 | 3 | # Interface: VideoResolution2 4 | 5 | Number of the columns of the Video image. 6 | 7 | ## Hierarchy 8 | 9 | * **VideoResolution2** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Height](_api_types_.videoresolution2.md#readonly-height) 16 | * [Width](_api_types_.videoresolution2.md#readonly-width) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Height 21 | 22 | • **Height**: *number* 23 | 24 | *Defined in [api/types.ts:855](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L855)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Width 29 | 30 | • **Width**: *number* 31 | 32 | *Defined in [api/types.ts:854](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L854)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videosourceconfigurationoptionsextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoSourceConfigurationOptionsExtension2](_api_types_.videosourceconfigurationoptionsextension2.md) 2 | 3 | # Interface: VideoSourceConfigurationOptionsExtension2 4 | 5 | Scene orientation modes supported by the device for this configuration. 6 | 7 | ## Hierarchy 8 | 9 | * **VideoSourceConfigurationOptionsExtension2** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [SceneOrientationMode](_api_types_.videosourceconfigurationoptionsextension2.md#optional-readonly-sceneorientationmode) 16 | 17 | ## Properties 18 | 19 | ### `Optional` `Readonly` SceneOrientationMode 20 | 21 | • **SceneOrientationMode**? : *[SceneOrientationMode](_api_types_.videosourceconfigurationoptionsextension2.md#optional-readonly-sceneorientationmode)* 22 | 23 | *Defined in [api/types.ts:685](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L685)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.videosourceextension2.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [VideoSourceExtension2](_api_types_.videosourceextension2.md) 2 | 3 | # Interface: VideoSourceExtension2 4 | 5 | ## Hierarchy 6 | 7 | * **VideoSourceExtension2** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.whitebalance20extension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WhiteBalance20Extension](_api_types_.whitebalance20extension.md) 2 | 3 | # Interface: WhiteBalance20Extension 4 | 5 | ## Hierarchy 6 | 7 | * **WhiteBalance20Extension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.whitebalanceoptions20extension.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WhiteBalanceOptions20Extension](_api_types_.whitebalanceoptions20extension.md) 2 | 3 | # Interface: WhiteBalanceOptions20Extension 4 | 5 | ## Hierarchy 6 | 7 | * **WhiteBalanceOptions20Extension** 8 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.widedynamicrange.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WideDynamicRange](_api_types_.widedynamicrange.md) 2 | 3 | # Interface: WideDynamicRange 4 | 5 | White dynamic range (on/off) 6 | 7 | ## Hierarchy 8 | 9 | * **WideDynamicRange** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Level](_api_types_.widedynamicrange.md#readonly-level) 16 | * [Mode](_api_types_.widedynamicrange.md#readonly-mode) 17 | 18 | ## Properties 19 | 20 | ### `Readonly` Level 21 | 22 | • **Level**: *number* 23 | 24 | *Defined in [api/types.ts:2694](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2694)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Mode 29 | 30 | • **Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* 31 | 32 | *Defined in [api/types.ts:2693](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2693)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.widedynamicrange20.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WideDynamicRange20](_api_types_.widedynamicrange20.md) 2 | 3 | # Interface: WideDynamicRange20 4 | 5 | Type describing whether WDR mode is enabled or disabled (on/off). 6 | 7 | ## Hierarchy 8 | 9 | * **WideDynamicRange20** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Level](_api_types_.widedynamicrange20.md#optional-readonly-level) 16 | * [Mode](_api_types_.widedynamicrange20.md#readonly-mode) 17 | 18 | ## Properties 19 | 20 | ### `Optional` `Readonly` Level 21 | 22 | • **Level**? : *undefined | number* 23 | 24 | *Defined in [api/types.ts:2979](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2979)* 25 | 26 | ___ 27 | 28 | ### `Readonly` Mode 29 | 30 | • **Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* 31 | 32 | *Defined in [api/types.ts:2978](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2978)* 33 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.widedynamicrangeoptions.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WideDynamicRangeOptions](_api_types_.widedynamicrangeoptions.md) 2 | 3 | # Interface: WideDynamicRangeOptions 4 | 5 | ## Hierarchy 6 | 7 | * **WideDynamicRangeOptions** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Level](_api_types_.widedynamicrangeoptions.md#readonly-level) 14 | * [Mode](_api_types_.widedynamicrangeoptions.md#readonly-mode) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` Level 19 | 20 | • **Level**: *[FloatRange](_api_types_.floatrange.md)* 21 | 22 | *Defined in [api/types.ts:2726](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2726)* 23 | 24 | ___ 25 | 26 | ### `Readonly` Mode 27 | 28 | • **Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* 29 | 30 | *Defined in [api/types.ts:2725](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2725)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.widedynamicrangeoptions20.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [WideDynamicRangeOptions20](_api_types_.widedynamicrangeoptions20.md) 2 | 3 | # Interface: WideDynamicRangeOptions20 4 | 5 | ## Hierarchy 6 | 7 | * **WideDynamicRangeOptions20** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [Level](_api_types_.widedynamicrangeoptions20.md#optional-readonly-level) 14 | * [Mode](_api_types_.widedynamicrangeoptions20.md#readonly-mode) 15 | 16 | ## Properties 17 | 18 | ### `Optional` `Readonly` Level 19 | 20 | • **Level**? : *[FloatRange](_api_types_.floatrange.md)* 21 | 22 | *Defined in [api/types.ts:3132](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3132)* 23 | 24 | ___ 25 | 26 | ### `Readonly` Mode 27 | 28 | • **Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* 29 | 30 | *Defined in [api/types.ts:3131](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L3131)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_api_types_.zoomlimits.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/types"](../modules/_api_types_.md) › [ZoomLimits](_api_types_.zoomlimits.md) 2 | 3 | # Interface: ZoomLimits 4 | 5 | A range of zoom limit 6 | 7 | ## Hierarchy 8 | 9 | * **ZoomLimits** 10 | 11 | ## Index 12 | 13 | ### Properties 14 | 15 | * [Range](_api_types_.zoomlimits.md#readonly-range) 16 | 17 | ## Properties 18 | 19 | ### `Readonly` Range 20 | 21 | • **Range**: *[Space1DDescription](_api_types_.space1ddescription.md)* 22 | 23 | *Defined in [api/types.ts:2415](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/api/types.ts#L2415)* 24 | -------------------------------------------------------------------------------- /docs/interfaces/_config_interfaces_.iusercredentials.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["config/interfaces"](../modules/_config_interfaces_.md) › [IUserCredentials](_config_interfaces_.iusercredentials.md) 2 | 3 | # Interface: IUserCredentials 4 | 5 | ## Hierarchy 6 | 7 | * **IUserCredentials** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [password](_config_interfaces_.iusercredentials.md#readonly-password) 14 | * [username](_config_interfaces_.iusercredentials.md#readonly-username) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` password 19 | 20 | • **password**: *string* 21 | 22 | *Defined in [config/interfaces.ts:31](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/config/interfaces.ts#L31)* 23 | 24 | ___ 25 | 26 | ### `Readonly` username 27 | 28 | • **username**: *string* 29 | 30 | *Defined in [config/interfaces.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/config/interfaces.ts#L30)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_manage_device_.imanageddevice.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["manage/device"](../modules/_manage_device_.md) › [IManagedDevice](_manage_device_.imanageddevice.md) 2 | 3 | # Interface: IManagedDevice 4 | 5 | ## Hierarchy 6 | 7 | * **IManagedDevice** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [api](_manage_device_.imanageddevice.md#readonly-api) 14 | 15 | ## Properties 16 | 17 | ### `Readonly` api 18 | 19 | • **api**: *[ManagedONVIFApi](../classes/_api_index_.managedonvifapi.md)* 20 | 21 | *Defined in [manage/device.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/manage/device.ts#L9)* 22 | 23 | ONVIF standard API 24 | -------------------------------------------------------------------------------- /docs/interfaces/_soap_auth_.iusercredentials.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["soap/auth"](../modules/_soap_auth_.md) › [IUserCredentials](_soap_auth_.iusercredentials.md) 2 | 3 | # Interface: IUserCredentials 4 | 5 | ## Hierarchy 6 | 7 | * **IUserCredentials** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [password](_soap_auth_.iusercredentials.md#readonly-password) 14 | * [username](_soap_auth_.iusercredentials.md#readonly-username) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` password 19 | 20 | • **password**: *string* 21 | 22 | *Defined in [soap/auth.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/auth.ts#L13)* 23 | 24 | ___ 25 | 26 | ### `Readonly` username 27 | 28 | • **username**: *string* 29 | 30 | *Defined in [soap/auth.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/auth.ts#L12)* 31 | -------------------------------------------------------------------------------- /docs/interfaces/_soap_request_.iresultstructure.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["soap/request"](../modules/_soap_request_.md) › [IResultStructure](_soap_request_.iresultstructure.md) 2 | 3 | # Interface: IResultStructure <**T**> 4 | 5 | ## Type parameters 6 | 7 | ▪ **T** 8 | 9 | ## Hierarchy 10 | 11 | * **IResultStructure** 12 | 13 | ## Index 14 | 15 | ### Properties 16 | 17 | * [json](_soap_request_.iresultstructure.md#readonly-json) 18 | * [xml](_soap_request_.iresultstructure.md#readonly-xml) 19 | 20 | ## Properties 21 | 22 | ### `Readonly` json 23 | 24 | • **json**: *T* 25 | 26 | *Defined in [soap/request.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/request.ts#L9)* 27 | 28 | ___ 29 | 30 | ### `Readonly` xml 31 | 32 | • **xml**: *string* 33 | 34 | *Defined in [soap/request.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/request.ts#L10)* 35 | -------------------------------------------------------------------------------- /docs/interfaces/_soap_request_.ixmlcontainer.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["soap/request"](../modules/_soap_request_.md) › [IXmlContainer](_soap_request_.ixmlcontainer.md) 2 | 3 | # Interface: IXmlContainer 4 | 5 | ## Hierarchy 6 | 7 | * **IXmlContainer** 8 | 9 | ## Index 10 | 11 | ### Properties 12 | 13 | * [xmlDocument](_soap_request_.ixmlcontainer.md#readonly-xmldocument) 14 | * [xmlString](_soap_request_.ixmlcontainer.md#readonly-xmlstring) 15 | 16 | ## Properties 17 | 18 | ### `Readonly` xmlDocument 19 | 20 | • **xmlDocument**: *Document* 21 | 22 | *Defined in [soap/request.ts:117](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/request.ts#L117)* 23 | 24 | ___ 25 | 26 | ### `Readonly` xmlString 27 | 28 | • **xmlString**: *string* 29 | 30 | *Defined in [soap/request.ts:116](https://github.com/patrickmichalina/onvif-rx/blob/3e9b152/src/soap/request.ts#L116)* 31 | -------------------------------------------------------------------------------- /docs/modules/_api_advancedsecurity_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/advancedsecurity"](_api_advancedsecurity_.md) 2 | 3 | # Module: "api/advancedsecurity" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFAdvancedSecurity](../classes/_api_advancedsecurity_.onvifadvancedsecurity.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_analytics_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/analytics"](_api_analytics_.md) 2 | 3 | # Module: "api/analytics" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFAnalytics](../classes/_api_analytics_.onvifanalytics.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_device_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/device"](_api_device_.md) 2 | 3 | # Module: "api/device" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFDevice](../classes/_api_device_.onvifdevice.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_display_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/display"](_api_display_.md) 2 | 3 | # Module: "api/display" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFDisplay](../classes/_api_display_.onvifdisplay.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_event_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/event"](_api_event_.md) 2 | 3 | # Module: "api/event" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFEvent](../classes/_api_event_.onvifevent.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_imaging_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/imaging"](_api_imaging_.md) 2 | 3 | # Module: "api/imaging" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFImaging](../classes/_api_imaging_.onvifimaging.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_media_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/media"](_api_media_.md) 2 | 3 | # Module: "api/media" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFMedia](../classes/_api_media_.onvifmedia.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_provisioning_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/provisioning"](_api_provisioning_.md) 2 | 3 | # Module: "api/provisioning" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFProvisioning](../classes/_api_provisioning_.onvifprovisioning.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_ptz_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/ptz"](_api_ptz_.md) 2 | 3 | # Module: "api/ptz" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFPTZ](../classes/_api_ptz_.onvifptz.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_receiver_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/receiver"](_api_receiver_.md) 2 | 3 | # Module: "api/receiver" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFReceiver](../classes/_api_receiver_.onvifreceiver.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_recording_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/recording"](_api_recording_.md) 2 | 3 | # Module: "api/recording" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFRecording](../classes/_api_recording_.onvifrecording.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_replay_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/replay"](_api_replay_.md) 2 | 3 | # Module: "api/replay" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFReplay](../classes/_api_replay_.onvifreplay.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_api_search_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["api/search"](_api_search_.md) 2 | 3 | # Module: "api/search" 4 | 5 | ## Index 6 | 7 | ### Classes 8 | 9 | * [ONVIFSearch](../classes/_api_search_.onvifsearch.md) 10 | -------------------------------------------------------------------------------- /docs/modules/_manage_index_.md: -------------------------------------------------------------------------------- 1 | [onvif-rx](../README.md) › ["manage/index"](_manage_index_.md) 2 | 3 | # Module: "manage/index" 4 | 5 | ## Index 6 | 7 | ### References 8 | 9 | * [IDeviceInitConfig](_manage_index_.md#ideviceinitconfig) 10 | * [IManagedDevice](_manage_index_.md#imanageddevice) 11 | * [createManagedDevice](_manage_index_.md#createmanageddevice) 12 | 13 | ## References 14 | 15 | ### IDeviceInitConfig 16 | 17 | • **IDeviceInitConfig**: 18 | 19 | ___ 20 | 21 | ### IManagedDevice 22 | 23 | • **IManagedDevice**: 24 | 25 | ___ 26 | 27 | ### createManagedDevice 28 | 29 | • **createManagedDevice**: 30 | -------------------------------------------------------------------------------- /scripts/publish-prep.ts: -------------------------------------------------------------------------------- 1 | import { copy, ensureDir } from 'fs-extra' 2 | import { resolve } from 'path' 3 | 4 | const targetDir = resolve('dist') 5 | const filesToCopy: ReadonlyArray = [ 6 | 'package.json', 7 | 'README.md', 8 | 'LICENSE' 9 | ] 10 | 11 | ensureDir(targetDir) 12 | .then(() => Promise.all(filesToCopy.map(path => copy(path, resolve(targetDir, path))))) 13 | -------------------------------------------------------------------------------- /scripts/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tsconfig.json", 3 | "include": [ 4 | "**/*.ts" 5 | ] 6 | } -------------------------------------------------------------------------------- /src/browser.ts: -------------------------------------------------------------------------------- 1 | import { IDeviceInitConfig, createManagedDevice } from '.' 2 | import { DEFAULT_BROWSER_ENV } from './config/browser' 3 | 4 | export * from './config/browser' 5 | export * from './index' 6 | 7 | export const createManagedDeviceInBrowser = 8 | (config: IDeviceInitConfig) => 9 | createManagedDevice(config) 10 | .run(DEFAULT_BROWSER_ENV) 11 | -------------------------------------------------------------------------------- /src/config/browser.ts: -------------------------------------------------------------------------------- 1 | import { ISystemConfig } from './interfaces' 2 | import { nonce, sharedFetchWrapper, FETCH_CONFIG } from './universal' 3 | import { Buffer } from 'buffer' 4 | 5 | const digestSha1 = 6 | (data: string) => 7 | crypto.subtle.digest('SHA-1', new TextEncoder().encode(data)) 8 | .then(hash => Array.from(new Uint8Array(hash)).map(b => b.toString(16).padStart(2, '0')).join('')) 9 | 10 | const transport = 11 | (body: string) => 12 | (uri: string) => 13 | sharedFetchWrapper(fetch(uri, FETCH_CONFIG(body))) 14 | 15 | export const DEFAULT_BROWSER_ENV: ISystemConfig = { 16 | parser: typeof DOMParser !== 'undefined' ? new DOMParser() : {} as DOMParser, 17 | nonce, 18 | digestSha1, 19 | transport, 20 | buffer: Buffer 21 | } 22 | -------------------------------------------------------------------------------- /src/config/index.ts: -------------------------------------------------------------------------------- 1 | export * from './browser' 2 | export * from './interfaces' 3 | export * from './node' 4 | export * from './universal' -------------------------------------------------------------------------------- /src/config/interfaces.ts: -------------------------------------------------------------------------------- 1 | import { Observable } from 'rxjs' 2 | import { IMaybe } from 'typescript-monads' 3 | 4 | export interface ITransportPayoad { 5 | readonly body: string 6 | readonly statusMessage: string 7 | readonly status: number 8 | } 9 | 10 | export type ITransport = (body: string) => (uri: string) => Observable 11 | export type IEncodeBase64 = (str: string) => string 12 | export type ISha1Digest = (str: string) => PromiseLike 13 | export type INonce = (size?: number) => string 14 | 15 | export interface ISystemConfig { 16 | readonly parser: DOMParser 17 | readonly transport: ITransport 18 | readonly nonce: INonce 19 | readonly buffer: any 20 | readonly digestSha1: ISha1Digest 21 | } 22 | 23 | export interface IDeviceConfig { 24 | readonly system: ISystemConfig 25 | readonly deviceUrl: string 26 | readonly user: IMaybe 27 | } 28 | 29 | export interface IUserCredentials { 30 | readonly username: string 31 | readonly password: string 32 | } -------------------------------------------------------------------------------- /src/config/universal.ts: -------------------------------------------------------------------------------- 1 | import { INonce, ITransportPayoad } from './interfaces' 2 | import { from, of } from 'rxjs' 3 | import { flatMap, catchError } from 'rxjs/operators' 4 | import { Response } from 'node-fetch' 5 | 6 | export const REQUEST_HEADERS = { 'Content-Type': 'application/soap+xml; charset=utf-8;' } 7 | export const FETCH_CONFIG = (body: string) => ({ method: 'POST', body, headers: REQUEST_HEADERS }) 8 | 9 | export const sharedFetchWrapper = 10 | (fetchResponse: Promise) => 11 | from(fetchResponse) 12 | .pipe( 13 | flatMap>(a => a.text().then(body => { 14 | return { 15 | body, 16 | status: a.status, 17 | statusMessage: a.statusText 18 | } 19 | })) 20 | ) 21 | 22 | export const nonce: INonce = 23 | (size = 30) => 24 | Array.from([...Array(size)]).map(() => Math.random().toString(36)[3]).join('') -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './manage' 2 | export * from './api' 3 | export * from './api/types' 4 | -------------------------------------------------------------------------------- /src/manage/device.ts: -------------------------------------------------------------------------------- 1 | import { maybe, reader } from 'typescript-monads' 2 | import { IDeviceConfig, ISystemConfig, IUserCredentials } from '../config/interfaces' 3 | import { ManagedONVIFApi } from '../api' 4 | 5 | export interface IManagedDevice { 6 | /** 7 | * ONVIF standard API 8 | */ 9 | readonly api: ManagedONVIFApi 10 | } 11 | 12 | export interface IDeviceInitConfig { 13 | readonly deviceUrl: string 14 | readonly username?: string 15 | readonly password?: string 16 | } 17 | 18 | export const createManagedDevice = (config: IDeviceInitConfig) => reader(system => { 19 | const innerRunConfig: IDeviceConfig = { 20 | system, 21 | deviceUrl: config.deviceUrl, 22 | user: config.username && config.password 23 | ? maybe({ username: config.username, password: config.password }) 24 | : maybe() 25 | } 26 | 27 | return { 28 | api: new ManagedONVIFApi(innerRunConfig) 29 | } 30 | }) 31 | -------------------------------------------------------------------------------- /src/manage/index.ts: -------------------------------------------------------------------------------- 1 | export * from './device' -------------------------------------------------------------------------------- /src/node.ts: -------------------------------------------------------------------------------- 1 | import { IDeviceInitConfig, createManagedDevice } from '.' 2 | import { DEFAULT_NODE_ENV } from './config/node' 3 | 4 | export * from './browser' 5 | export * from './index' 6 | 7 | export const createManagedDeviceInNode = 8 | (config: IDeviceInitConfig) => 9 | createManagedDevice(config) 10 | .run(DEFAULT_NODE_ENV) 11 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "module": "commonjs", 5 | "moduleResolution": "node", 6 | "lib": ["es2015", "dom"], 7 | "outDir": "dist", 8 | "noEmit": true, 9 | "isolatedModules": false, 10 | "experimentalDecorators": true, 11 | "emitDecoratorMetadata": true, 12 | "noImplicitAny": true, 13 | "noImplicitUseStrict": false, 14 | "noEmitHelpers": false, 15 | "noLib": false, 16 | "noUnusedLocals": false, 17 | "noEmitOnError": true, 18 | "allowSyntheticDefaultImports": false, 19 | "skipLibCheck": true, 20 | "skipDefaultLibCheck": true, 21 | "strict": true, 22 | "strictNullChecks": true, 23 | "strictFunctionTypes": true, 24 | "forceConsistentCasingInFileNames": true, 25 | "declaration": true, 26 | "sourceMap": true, 27 | }, 28 | "include": [ 29 | "src/**/*.ts" 30 | ] 31 | } -------------------------------------------------------------------------------- /tsconfig.rollup.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "module": "es2015", 5 | "moduleResolution": "node", 6 | "lib": ["es2015", "dom"], 7 | "outDir": "dist", 8 | "isolatedModules": false, 9 | "experimentalDecorators": true, 10 | "emitDecoratorMetadata": true, 11 | "noImplicitAny": true, 12 | "noImplicitUseStrict": false, 13 | "noEmitHelpers": false, 14 | "noLib": false, 15 | "noUnusedLocals": false, 16 | "noEmitOnError": true, 17 | "allowSyntheticDefaultImports": false, 18 | "skipLibCheck": true, 19 | "skipDefaultLibCheck": true, 20 | "strict": true, 21 | "strictNullChecks": true, 22 | "strictFunctionTypes": true, 23 | "forceConsistentCasingInFileNames": true, 24 | "declaration": true, 25 | "sourceMap": true, 26 | "noEmit": false 27 | }, 28 | "include": [ 29 | "src/**/*.ts" 30 | ] 31 | } --------------------------------------------------------------------------------