onvif-python 0.0.1__py3-none-any.whl

onvif/services/media2.py

@@ -0,0 +1,310 @@
+# onvif/services/media2.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class Media2:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("media2", "ver20")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="Media2",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def CreateProfile(self, Name, Configuration=None):
+        return self.operator.call(
+            "CreateProfile", Name=Name, Configuration=Configuration
+        )
+
+    def GetProfiles(self, Token=None, Type=None):
+        return self.operator.call("GetProfiles", Token=Token, Type=Type)
+
+    def AddConfiguration(self, ProfileToken, Name=None, Configuration=None):
+        return self.operator.call(
+            "AddConfiguration",
+            ProfileToken=ProfileToken,
+            Name=Name,
+            Configuration=Configuration,
+        )
+
+    def RemoveConfiguration(self, ProfileToken, Configuration):
+        return self.operator.call(
+            "RemoveConfiguration",
+            ProfileToken=ProfileToken,
+            Configuration=Configuration,
+        )
+
+    def DeleteProfile(self, Token):
+        return self.operator.call("DeleteProfile", Token=Token)
+
+    def GetVideoSourceConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetVideoSourceConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetVideoEncoderConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetVideoEncoderConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioSourceConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetAudioSourceConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioEncoderConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetAudioEncoderConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAnalyticsConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetAnalyticsConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetMetadataConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetMetadataConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioOutputConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetAudioOutputConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioDecoderConfigurations(self, ConfigurationToken=None, ProfileToken=None):
+        return self.operator.call(
+            "GetAudioDecoderConfigurations",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def SetVideoSourceConfiguration(self, Configuration):
+        return self.operator.call(
+            "SetVideoSourceConfiguration", Configuration=Configuration
+        )
+
+    def SetVideoEncoderConfiguration(self, Configuration):
+        return self.operator.call(
+            "SetVideoEncoderConfiguration", Configuration=Configuration
+        )
+
+    def SetAudioSourceConfiguration(self, Configuration):
+        return self.operator.call(
+            "SetAudioSourceConfiguration", Configuration=Configuration
+        )
+
+    def SetAudioEncoderConfiguration(self, Configuration):
+        return self.operator.call(
+            "SetAudioEncoderConfiguration", Configuration=Configuration
+        )
+
+    def SetMetadataConfiguration(self, Configuration):
+        return self.operator.call(
+            "SetMetadataConfiguration", Configuration=Configuration
+        )
+
+    def SetAudioOutputConfiguration(self, Configuration):
+        return self.operator.call(
+            "SetAudioOutputConfiguration", Configuration=Configuration
+        )
+
+    def SetAudioDecoderConfiguration(self, Configuration):
+        return self.operator.call(
+            "SetAudioDecoderConfiguration", Configuration=Configuration
+        )
+
+    def SetEQPreset(self, Configuration):
+        return self.operator.call("SetEQPreset", Configuration=Configuration)
+
+    def GetVideoSourceConfigurationOptions(
+        self, ConfigurationToken=None, ProfileToken=None
+    ):
+        return self.operator.call(
+            "GetVideoSourceConfigurationOptions",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetVideoEncoderConfigurationOptions(
+        self, ConfigurationToken=None, ProfileToken=None
+    ):
+        return self.operator.call(
+            "GetVideoEncoderConfigurationOptions",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioSourceConfigurationOptions(
+        self, ConfigurationToken=None, ProfileToken=None
+    ):
+        return self.operator.call(
+            "GetAudioSourceConfigurationOptions",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioEncoderConfigurationOptions(
+        self, ConfigurationToken=None, ProfileToken=None
+    ):
+        return self.operator.call(
+            "GetAudioEncoderConfigurationOptions",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetMetadataConfigurationOptions(
+        self, ConfigurationToken=None, ProfileToken=None
+    ):
+        return self.operator.call(
+            "GetMetadataConfigurationOptions",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioOutputConfigurationOptions(
+        self, ConfigurationToken=None, ProfileToken=None
+    ):
+        return self.operator.call(
+            "GetAudioOutputConfigurationOptions",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetAudioDecoderConfigurationOptions(
+        self, ConfigurationToken=None, ProfileToken=None
+    ):
+        return self.operator.call(
+            "GetAudioDecoderConfigurationOptions",
+            ConfigurationToken=ConfigurationToken,
+            ProfileToken=ProfileToken,
+        )
+
+    def GetVideoEncoderInstances(self, ConfigurationToken):
+        return self.operator.call(
+            "GetVideoEncoderInstances", ConfigurationToken=ConfigurationToken
+        )
+
+    def GetStreamUri(self, Protocol, ProfileToken):
+        return self.operator.call(
+            "GetStreamUri", Protocol=Protocol, ProfileToken=ProfileToken
+        )
+
+    def StartMulticastStreaming(self, ProfileToken):
+        return self.operator.call("StartMulticastStreaming", ProfileToken=ProfileToken)
+
+    def StopMulticastStreaming(self, ProfileToken):
+        return self.operator.call("StopMulticastStreaming", ProfileToken=ProfileToken)
+
+    def SetSynchronizationPoint(self, ProfileToken):
+        return self.operator.call("SetSynchronizationPoint", ProfileToken=ProfileToken)
+
+    def GetSnapshotUri(self, ProfileToken):
+        return self.operator.call("GetSnapshotUri", ProfileToken=ProfileToken)
+
+    def GetVideoSourceModes(self, VideoSourceToken):
+        return self.operator.call(
+            "GetVideoSourceModes", VideoSourceToken=VideoSourceToken
+        )
+
+    def SetVideoSourceMode(self, VideoSourceToken, VideoSourceModeToken):
+        return self.operator.call(
+            "SetVideoSourceMode",
+            VideoSourceToken=VideoSourceToken,
+            VideoSourceModeToken=VideoSourceModeToken,
+        )
+
+    def GetOSDs(self, OSDToken=None, ConfigurationToken=None):
+        return self.operator.call(
+            "GetOSDs", OSDToken=OSDToken, ConfigurationToken=ConfigurationToken
+        )
+
+    def GetOSDOptions(self, ConfigurationToken):
+        return self.operator.call(
+            "GetOSDOptions", ConfigurationToken=ConfigurationToken
+        )
+
+    def SetOSD(self, OSD):
+        return self.operator.call("SetOSD", OSD=OSD)
+
+    def CreateOSD(self, OSD):
+        return self.operator.call("CreateOSD", OSD=OSD)
+
+    def DeleteOSD(self, OSDToken):
+        return self.operator.call("DeleteOSD", OSDToken=OSDToken)
+
+    def GetMasks(self, Token=None, ConfigurationToken=None):
+        return self.operator.call(
+            "GetMasks", Token=Token, ConfigurationToken=ConfigurationToken
+        )
+
+    def GetMaskOptions(self, ConfigurationToken):
+        return self.operator.call(
+            "GetMaskOptions", ConfigurationToken=ConfigurationToken
+        )
+
+    def SetMask(self, Mask):
+        return self.operator.call("SetMask", Mask=Mask)
+
+    def CreateMask(self, Mask):
+        return self.operator.call("CreateMask", Mask=Mask)
+
+    def DeleteMask(self, Token):
+        return self.operator.call("DeleteMask", Token=Token)
+
+    def GetWebRTCConfigurations(self):
+        return self.operator.call("GetWebRTCConfigurations")
+
+    def SetWebRTCConfigurations(self, WebRTCConfiguration=None):
+        return self.operator.call(
+            "SetWebRTCConfigurations", WebRTCConfiguration=WebRTCConfiguration
+        )
+
+    def GetAudioClips(self, Token=None):
+        return self.operator.call("GetAudioClips", Token=Token)
+
+    def AddAudioClip(self, Configuration, Token=None):
+        return self.operator.call(
+            "AddAudioClip", Token=Token, Configuration=Configuration
+        )
+
+    def SetAudioClip(self, Token, Configuration):
+        return self.operator.call(
+            "SetAudioClip", Token=Token, Configuration=Configuration
+        )
+
+    def DeleteAudioClip(self, Token):
+        return self.operator.call("DeleteAudioClip", Token=Token)
+
+    def PlayAudioClip(self, Token, Play, AudioOutputToken=None, RepeatCycles=None):
+        return self.operator.call(
+            "PlayAudioClip",
+            Token=Token,
+            AudioOutputToken=AudioOutputToken,
+            Play=Play,
+            RepeatCycles=RepeatCycles,
+        )
+
+    def GetPlayingAudioClips(self):
+        return self.operator.call("GetPlayingAudioClips")

onvif/services/provisioning.py

@@ -0,0 +1,50 @@
+# onvif/services/provisioning.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class Provisioning:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("provisioning")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="Provisioning",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def PanMove(self, VideoSource, Direction, Timeout=None):
+        return self.operator.call(
+            "PanMove", VideoSource=VideoSource, Direction=Direction, Timeout=Timeout
+        )
+
+    def TiltMove(self, VideoSource, Direction, Timeout=None):
+        return self.operator.call(
+            "TiltMove", VideoSource=VideoSource, Direction=Direction, Timeout=Timeout
+        )
+
+    def ZoomMove(self, VideoSource, Direction, Timeout=None):
+        return self.operator.call(
+            "ZoomMove", VideoSource=VideoSource, Direction=Direction, Timeout=Timeout
+        )
+
+    def RollMove(self, VideoSource, Direction, Timeout=None):
+        return self.operator.call(
+            "RollMove", VideoSource=VideoSource, Direction=Direction, Timeout=Timeout
+        )
+
+    def FocusMove(self, VideoSource, Direction, Timeout=None):
+        return self.operator.call(
+            "FocusMove", VideoSource=VideoSource, Direction=Direction, Timeout=Timeout
+        )
+
+    def Stop(self, VideoSource):
+        return self.operator.call("Stop", VideoSource=VideoSource)
+
+    def GetUsage(self, VideoSource):
+        return self.operator.call("GetUsage", VideoSource=VideoSource)

onvif/services/ptz.py

@@ -0,0 +1,187 @@
+# onvif/services/ptz.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class PTZ:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("ptz", "ver20")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="PTZ",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def GetConfigurations(self):
+        return self.operator.call("GetConfigurations")
+
+    def GetPresets(self, ProfileToken):
+        return self.operator.call("GetPresets", ProfileToken=ProfileToken)
+
+    def SetPreset(self, ProfileToken, PresetName=None, PresetToken=None):
+        return self.operator.call(
+            "SetPreset",
+            ProfileToken=ProfileToken,
+            PresetName=PresetName,
+            PresetToken=PresetToken,
+        )
+
+    def RemovePreset(self, ProfileToken, PresetToken):
+        return self.operator.call(
+            "RemovePreset", ProfileToken=ProfileToken, PresetToken=PresetToken
+        )
+
+    def GotoPreset(self, ProfileToken, PresetToken, Speed=None):
+        return self.operator.call(
+            "GotoPreset",
+            ProfileToken=ProfileToken,
+            PresetToken=PresetToken,
+            Speed=Speed,
+        )
+
+    def GetStatus(self, ProfileToken):
+        return self.operator.call("GetStatus", ProfileToken=ProfileToken)
+
+    def GetConfiguration(self, PTZConfigurationToken):
+        return self.operator.call(
+            "GetConfiguration", PTZConfigurationToken=PTZConfigurationToken
+        )
+
+    def GetNodes(self):
+        return self.operator.call("GetNodes")
+
+    def GetNode(self, NodeToken):
+        return self.operator.call("GetNode", NodeToken=NodeToken)
+
+    def SetConfiguration(self, PTZConfiguration, ForcePersistence):
+        return self.operator.call(
+            "SetConfiguration",
+            PTZConfiguration=PTZConfiguration,
+            ForcePersistence=ForcePersistence,
+        )
+
+    def GetConfigurationOptions(self, ConfigurationToken):
+        return self.operator.call(
+            "GetConfigurationOptions", ConfigurationToken=ConfigurationToken
+        )
+
+    def GotoHomePosition(self, ProfileToken, Speed=None):
+        return self.operator.call(
+            "GotoHomePosition", ProfileToken=ProfileToken, Speed=Speed
+        )
+
+    def SetHomePosition(self, ProfileToken):
+        return self.operator.call("SetHomePosition", ProfileToken=ProfileToken)
+
+    def ContinuousMove(self, ProfileToken, Velocity, Timeout=None):
+        return self.operator.call(
+            "ContinuousMove",
+            ProfileToken=ProfileToken,
+            Velocity=Velocity,
+            Timeout=Timeout,
+        )
+
+    def RelativeMove(self, ProfileToken, Translation, Speed=None):
+        return self.operator.call(
+            "RelativeMove",
+            ProfileToken=ProfileToken,
+            Translation=Translation,
+            Speed=Speed,
+        )
+
+    def SendAuxiliaryCommand(self, ProfileToken, AuxiliaryData):
+        return self.operator.call(
+            "SendAuxiliaryCommand",
+            ProfileToken=ProfileToken,
+            AuxiliaryData=AuxiliaryData,
+        )
+
+    def AbsoluteMove(self, ProfileToken, Position, Speed=None):
+        return self.operator.call(
+            "AbsoluteMove", ProfileToken=ProfileToken, Position=Position, Speed=Speed
+        )
+
+    def GeoMove(
+        self, ProfileToken, Target, Speed=None, AreaHeight=None, AreaWidth=None
+    ):
+        return self.operator.call(
+            "GeoMove",
+            ProfileToken=ProfileToken,
+            Target=Target,
+            Speed=Speed,
+            AreaHeight=AreaHeight,
+            AreaWidth=AreaWidth,
+        )
+
+    def Stop(self, ProfileToken, PanTilt=None, Zoom=None):
+        return self.operator.call(
+            "Stop", ProfileToken=ProfileToken, PanTilt=PanTilt, Zoom=Zoom
+        )
+
+    def GetPresetTours(self, ProfileToken):
+        return self.operator.call("GetPresetTours", ProfileToken=ProfileToken)
+
+    def GetPresetTour(self, ProfileToken, PresetTourToken):
+        return self.operator.call(
+            "GetPresetTour", ProfileToken=ProfileToken, PresetTourToken=PresetTourToken
+        )
+
+    def GetPresetTourOptions(self, ProfileToken, PresetTourToken=None):
+        return self.operator.call(
+            "GetPresetTourOptions",
+            ProfileToken=ProfileToken,
+            PresetTourToken=PresetTourToken,
+        )
+
+    def CreatePresetTour(self, ProfileToken):
+        return self.operator.call("CreatePresetTour", ProfileToken=ProfileToken)
+
+    def ModifyPresetTour(self, ProfileToken, PresetTour):
+        return self.operator.call(
+            "ModifyPresetTour", ProfileToken=ProfileToken, PresetTour=PresetTour
+        )
+
+    def OperatePresetTour(self, ProfileToken, PresetTourToken, Operation):
+        return self.operator.call(
+            "OperatePresetTour",
+            ProfileToken=ProfileToken,
+            PresetTourToken=PresetTourToken,
+            Operation=Operation,
+        )
+
+    def RemovePresetTour(self, ProfileToken, PresetTourToken):
+        return self.operator.call(
+            "RemovePresetTour",
+            ProfileToken=ProfileToken,
+            PresetTourToken=PresetTourToken,
+        )
+
+    def GetCompatibleConfigurations(self, ProfileToken):
+        return self.operator.call(
+            "GetCompatibleConfigurations", ProfileToken=ProfileToken
+        )
+
+    def MoveAndStartTracking(
+        self,
+        ProfileToken,
+        ObjectID,
+        PresetToken=None,
+        GeoLocation=None,
+        TargetPosition=None,
+        Speed=None,
+    ):
+        return self.operator.call(
+            "MoveAndStartTracking",
+            ProfileToken=ProfileToken,
+            PresetToken=PresetToken,
+            GeoLocation=GeoLocation,
+            TargetPosition=TargetPosition,
+            Speed=Speed,
+            ObjectID=ObjectID,
+        )

onvif/services/receiver.py

@@ -0,0 +1,46 @@
+# onvif/services/receiver.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class Receiver:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("receiver")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="Receiver",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def GetReceivers(self):
+        return self.operator.call("GetReceivers")
+
+    def GetReceiver(self, ReceiverToken):
+        return self.operator.call("GetReceiver", ReceiverToken=ReceiverToken)
+
+    def CreateReceiver(self, Configuration):
+        return self.operator.call("CreateReceiver", Configuration=Configuration)
+
+    def DeleteReceiver(self, ReceiverToken):
+        return self.operator.call("DeleteReceiver", ReceiverToken=ReceiverToken)
+
+    def ConfigureReceiver(self, ReceiverToken, Configuration):
+        return self.operator.call(
+            "ConfigureReceiver",
+            ReceiverToken=ReceiverToken,
+            Configuration=Configuration,
+        )
+
+    def SetReceiverMode(self, ReceiverToken, Mode):
+        return self.operator.call(
+            "SetReceiverMode", ReceiverToken=ReceiverToken, Mode=Mode
+        )
+
+    def GetReceiverState(self, ReceiverToken):
+        return self.operator.call("GetReceiverState", ReceiverToken=ReceiverToken)