command library
Classes
-
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.
-
OnvifCreateUsersDeviceManagementCommand
-
This operation creates new device users and corresponding credentials on a
device for authentication purposes. The device shall support creation of
device users and their credentials through the CreateUsers command. Either
all users are created successfully or a fault message shall be returned
without creating any user.
-
OnvifDeleteUsersDeviceManagementCommand
-
This operation deletes the given storage configuration and configuration
change shall always be persistent.
-
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.
-
OnvifGetCompatibleConfigurationsPtzCommand
-
Operation to get all available PTZConfigurations that can be added to the
referenced media profile.
-
OnvifGetConfigurationOptionsPtzCommand
-
List supported coordinate systems including their range limitations.
Therefore, the options MAY differ depending on whether the PTZ Configuration
is assigned to a Profile containing a Video Source Configuration. In that
case, the options may additionally contain coordinate systems referring to
the image coordinate system described by the Video Source Configuration. If
the PTZ Node supports continuous movements, it shall return a Timeout Range
within which Timeouts are accepted by the PTZ Node.
-
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.
-
OnvifGetDiscoveryModeDeviceManagementCommand
-
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.
-
OnvifGetDnsDeviceManagementCommand
-
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.
-
OnvifGetMetadataConfiguration1MediaCommand
-
The GetMetadataConfiguration command fetches the metadata configuration if
the metadata token is known.
-
OnvifGetMetadataConfigurationOptionsMediaCommand
-
This operation returns the available options (supported values and ranges
for metadata configuration parameters) for changing the metadata
configuration.
-
OnvifGetMetadataConfigurations1MediaCommand
-
This operation returns the available options (supported values and ranges
for metadata configuration parameters) for changing the metadata
configuration.
-
OnvifGetMetadataConfigurations2MediaCommand
-
By default this operation lists all existing metadata configurations for a
device. Provide a profile token to list only configurations that are
compatible with the profile. If a configuration token is provided only a
single configuration will be returned.
-
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.
-
OnvifGetProfileMediaCommand
-
If the profile token is already known, a profile can be fetched through the
GetProfile command.
-
OnvifGetProfiles1MediaCommand
-
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.
-
OnvifGetProfiles2MediaCommand
-
Retrieve the profile with the specified token or all defined media profiles.
-
OnvifGetServiceCapabilities1MediaCommand
-
Returns the capabilities of the media service. The result is returned in a
typed answer.
-
OnvifGetServiceCapabilities2MediaCommand
-
Returns the capabilities of the media service. The result is returned in a
typed answer.
-
OnvifGetServiceCapabilitiesDeviceManagementCommand
-
Returns the capabilities of the device service. The result is returned in a typed answer.
-
OnvifGetServiceCapabilitiesPtzCommand
-
Returns the capabilities of the PTZ service. The result is returned in a
typed answer.
-
OnvifGetServicesDeviceManagementCommand
-
Returns information about services on the device.
-
OnvifGetSnapshotUri1MediaCommand
-
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.
-
OnvifGetSnapshotUri2MediaCommand
-
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.
-
OnvifGetStreamUri1MediaCommand
-
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).
-
OnvifGetStreamUri2MediaCommand
-
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.
-
OnvifGetVideoEncoderInstancesMediaCommand
-
The GetVideoEncoderInstances command can be used to request the minimum
number of guaranteed video encoder instances (applications) per Video Source
Configuration.
-
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
-
-
OnvifMedia1Command
-
-
OnvifMedia2Command
-
-
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.
-
OnvifSetHomePositionPtzCommand
-
Operation to save current position as the home position. The SetHomePosition
command returns with a failure if the “home” position is fixed and cannot be
overwritten. If the SetHomePosition is successful, it is possible to recall
the Home Position with the GotoHomePosition command.
-
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.
-
OnvifStartMulticastStreaming1MediaCommand
-
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.
-
OnvifStartMulticastStreaming2MediaCommand
-
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.
-
OnvifStopMulticastStreaming1MediaCommand
-
This command stop multicast streaming using a specified media profile of a device.
-
OnvifStopMulticastStreaming2MediaCommand
-
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.
-
OnvifVersionCommand
-
-
OnvifZoomInPtzCommand
-
Operation for a single step zoom in operation.
-
OnvifZoomOutPtzCommand
-
Operation for a single step zoom out operation.
-
OnvifZoomPtzCommand
-
Operation for zoom.