easy_onvif library Null safety

ONVIF Client Implementation in Dart

Classes

AbsoluteMoveResponse
AudioSource
List of existing Audio Sources
Authorization
Implementation of the Authorization algorithm required to authenticate to Onvif devices
Capabilities
Capability information.
ContinuousMoveResponse
DeviceManagement
DeviceServiceCapabilities
The capabilities for the device service is returned in the Capabilities element.
DnsInformation
DNS Information.
Envelope
GetAudioSourcesResponse
This command lists all available physical audio inputs of the device.
GetCapabilitiesResponse
This method has been replaced by the more generic GetServices method. For capabilities of individual services refer to the DeviceManagement.getServiceCapabilities methods.
GetCompatibleConfigurationsResponse
Operation to get all available PTZConfigurations that can be added to the referenced media profile.
GetConfigurationResponse
Get a specific PTZconfiguration from the device, identified by its reference token or name.
GetConfigurationsResponse
Get all the existing PTZConfigurations from the device.
GetDeviceInformationResponse
This operation gets basic device information from the device.
GetDiscoveryModeResponse
This operation gets the discovery mode of a device. See Section 7.2 for the definition of the different device discovery modes. The device shall support retrieval of the discovery mode setting through the GetDiscoveryMode command.
GetDnsResponse
This operation gets the discovery mode of a device. See Section 7.2 for the definition of the different device discovery modes. The device shall support retrieval of the discovery mode setting through the GetDnsInformation command.
GetHostnameResponse
GetMetadataConfigurationsResponse
This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.
GetNetworkProtocolsResponse
GetNTPResponse
NTP information.
GetPresetResponse
GetProfilesResponse
Any endpoint can ask for the existing media profiles of a device using the Media.getProfiles command. Pre-configured or dynamically configured profiles can be retrieved using this command. This command lists all configured profiles in a device. The client does not need to know the media profile in order to use the command.
GetServiceCapabilitiesResponse
The capabilities for the device service is returned in the Capabilities element.
GetServicesResponse
GetStatusResponse
GetSystemDateAndTimeResponse
Contains information whether system date and time are set manually or by NTP, daylight savings is on or off, time zone in POSIX 1003.1 format and system date and time in UTC and also local system date and time.
GetSystemUrisResponse
GetUriResponse
GetUsersResponse
GetVideoSourcesResponse
This operation lists all available physical video inputs of the device.
GotoHomePositionResponse
GotoPresetResponse
HostnameInformation
Media
MediaUri
MulticastProbe
NetworkProtocol
Nonce
implementse the Nonce algorithm specified by the Onvif spec.
NtpInformation
NTP information.
Onvif
OnvifAbsoluteMovePtzCommand
Operation to move pan,tilt or zoom to a absolute destination.
OnvifAuthorizeCommand
Generate a refresh token used to authenticate the command line API requests
OnvifContinuousMovePtzCommand
Operation for continuous Pan/Tilt and Zoom movements. The operation is supported if the PTZNode supports at least one continuous Pan/Tilt or Zoom space. If the space argument is omitted, the default space set by the PTZConfiguration will be used.
OnvifDeviceManagementCommand
device management
OnvifGetAudioSourcesMediaCommand
This command lists all available physical audio inputs of the device.
OnvifGetCapabilitiesDeviceManagementCommand
This method has been replaced by the more generic GetServices method. For capabilities of individual services refer to the GetServiceCapabilities methods.
OnvifGetConfigurationPtzCommand
Get a specific PTZconfiguration from the device, identified by its reference token or name.
OnvifGetConfigurationsPtzCommand
Get all the existing PTZConfigurations from the device.
OnvifGetCurrentPresetPtzCommand
OnvifGetDeviceInformationResponseDeviceManagementCommand
This operation gets basic device information from the device.
OnvifGetDiscoveryModeCommand
This operation gets the discovery mode of a device. See Section 7.2 for the definition of the different device discovery modes. The device shall support retrieval of the discovery mode setting through the GetDiscoveryMode command.
OnvifGetDnsCommand
This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command.
OnvifGetHostnameDeviceManagementCommand
This operation is used by an endpoint to get the hostname from a device. The device shall return its hostname configurations through the GetHostname command.
OnvifGetNetworkProtocolsDeviceManagementCommand
This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols.
OnvifGetNtpDeviceManagementCommand
This operation gets the NTP settings from a device. If the device supports NTP, it shall be possible to get the NTP server settings through the GetNTP command.
OnvifGetPresetsPtzCommand
Operation to request all PTZ presets for the PTZNode in the selected profile. The operation is supported if there is support for at least on PTZ preset by the PTZNode.
OnvifGetProfilesMediaCommand
Any endpoint can ask for the existing media profiles of a device using the GetProfiles command. Pre-configured or dynamically configured profiles can be retrieved using this command. This command lists all configured profiles in a device. The client does not need to know the media profile in order to use the command.
OnvifGetServiceCapabilitiesDeviceManagementCommand
Returns the capabilities of the device service. The result is returned in a typed answer.
OnvifGetServicesDeviceManagementCommand
Returns information about services on the device.
OnvifGetSnapshotUriMediaCommand
A client uses the GetSnapshotUri command to obtain a JPEG snapshot from the device. The returned URI shall remain valid indefinitely even if the profile is changed. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S). The URI can be used for acquiring a JPEG image through a HTTP GET operation. The image encoding will always be JPEG regardless of the encoding setting in the media profile. The Jpeg settings (like resolution or quality) may be taken from the profile if suitable. The provided image will be updated automatically and independent from calls to GetSnapshotUri.
OnvifGetStatusPtzCommand
Operation to request PTZ status for the Node in the selected profile.
OnvifGetStreamUriMediaCommand
This operation requests a URI that can be used to initiate a live media stream using RTSP as the control protocol. The returned URI shall remain valid indefinitely even if the profile is changed. The ValidUntilConnect, ValidUntilReboot and Timeout Parameter shall be set accordingly (ValidUntilConnect=false, ValidUntilReboot=false, timeout=PT0S).
OnvifGetSystemDateAndTimeDeviceManagementCommand
This operation gets the device system date and time. The device shall support the return of the daylight saving setting and of the manual system date and time (if applicable) or indication of NTP time (if applicable) through the GetSystemDateAndTime command.
OnvifGetSystemUrisDeviceManagementCommand
This operation is used to retrieve URIs from which system information may be downloaded using HTTP. URIs may be returned for the following system information:
OnvifGetUsersDeviceManagementCommand
This operation lists the registered users and corresponding credentials on a device. The device shall support retrieval of registered device users and their credentials for the user token through the GetUsers command.
OnvifGetVideoSourcesMediaCommand
This command lists all available physical video inputs of the device.
OnvifGotoHomePositionPtzCommand
Operation to move the PTZ device to it's "home" position. The operation is supported if the HomeSupported element in the PTZNode is true.
OnvifGotoPresetPtzCommand
Operation to go to a saved preset position for the PTZNode in the selected profile. The operation is supported if there is support for at least on PTZ preset by the PTZNode.
OnvifHelperCommand
OnvifMediaCommand
OnvifMoveDownPtzCommand
Operation for a single step tilt down operation.
OnvifMoveLeftPtzCommand
Operation for a single step pan left operation.
OnvifMovePtzCommand
Operation for Relative Pan/Tilt Move without Zoom.
OnvifMoveRightPtzCommand
Operation for a single step pan right operation.
OnvifMoveUpPtzCommand
Operation for a single step tilt upwards operation.
OnvifProbeCommand
OnvifPtzCommand
OnvifRelativeMovePtzCommand
Operation for Relative Pan/Tilt and Zoom Move. The operation is supported if the PTZNode supports at least one relative Pan/Tilt or Zoom space.
OnvifRemovePresetPtzCommand
Operation to remove a PTZ preset for the Node in the selected profile. The operation is supported if the PresetPosition capability exists for teh Node in the selected profile.
OnvifSetPresetPtzCommand
The SetPreset command saves the current device position parameters so that the device can move to the saved preset position through the GotoPreset operation. In order to create a new preset, the SetPresetRequest contains no PresetToken. If creation is successful, the Response contains the PresetToken which uniquely identifies the Preset. An existing Preset can be overwritten by specifying the PresetToken of the corresponding Preset. In both cases (overwriting or creation) an optional PresetName can be specified. The operation fails if the PTZ device is moving during the SetPreset operation. The device MAY internally save additional states such as imaging properties in the PTZ Preset which then should be recalled in the GotoPreset operation.
OnvifStartMulticastStreamingMediaCommand
This command starts multicast streaming using a specified media profile of a device. Streaming continues until StopMulticastStreaming is called for the same Profile. The streaming shall continue after a reboot of the device until a StopMulticastStreaming request is received. The multicast address, port and TTL are configured in the VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration respectively.
OnvifStopMulticastStreamingMediaCommand
This command stop multicast streaming using a specified media profile of a device.
OnvifStopPtzCommand
Operation to stop ongoing pan, tilt and zoom movements of absolute relative and continuous type. If no stop argument for pan, tilt or zoom is set, the device will stop all ongoing pan, tilt and zoom movements.
OnvifUtil
Helper functions for Onvif related operations
OnvifVersionCommand
OnvifZoomInPtzCommand
Operation for a single step zoom in operation.
OnvifZoomOutPtzCommand
Operation for a single step zoom out operation.
OnvifZoomPtzCommand
Operation for zoom.
PanTilt
PanTiltLimits
A range of x or y-axis.
Preset
ProbeMatch
Profile
representation of a profile that exist in the media service
Ptz
PtzConfiguration
A specific PtzConfiguration from the device.
PtzPosition
PtzSpeed
If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
PtzStatus
Service
SetPresetResponse
Soap
Utility class for interacting through the SOAP protocol
SoapRequest
Helper methods for building the SoapRequest
StopResponse
SystemDateAndTime
Contains information whether system date and time are set manually or by NTP, daylight savings is on or off, time zone in POSIX 1003.1 format and system date and time in UTC and also local system date and time.
User
VideoSource
List of existing Video Sources
Xmlns
Zoom
ZoomLimits
A range of x or y-axis.

Extensions

UriExtension
UsageExtension