View Source ExOnvif.PTZ (ExOnvif v0.7.1)
Interface for making requests to the Onvif PTZ(Pan/Tilt/Zoom) service
Summary
Functions
Operation to move pan,tilt or zoom to a absolute destination.
Get a specific PTZ Node identified by a reference token or a name.
Get the descriptions of the available PTZ Nodes.
Returns the capabilities of the PTZ service.
Operation to request PTZ status for the Node in the selected profile.
Functions
@spec absolute_move(ExOnvif.Device.t(), ExOnvif.PTZ.AbsoluteMove.t()) :: :ok | {:error, any()}
Operation to move pan,tilt or zoom to a absolute destination.
The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used.
@spec get_node(ExOnvif.Device.t(), String.t()) :: {:ok, ExOnvif.PTZ.Node.t()} | {:error, any()}
Get a specific PTZ Node identified by a reference token or a name.
@spec get_nodes(ExOnvif.Device.t()) :: {:ok, [ExOnvif.PTZ.Node.t()]} | {:error, map()}
Get the descriptions of the available PTZ Nodes.
A PTZ-capable device may have multiple PTZ Nodes. The PTZ Nodes may represent mechanical PTZ drivers, uploaded PTZ drivers or digital PTZ drivers. PTZ Nodes are the lowest level entities in the PTZ control API and reflect the supported PTZ capabilities. The PTZ Node is referenced either by its name or by its reference token.
@spec get_service_capabilities(ExOnvif.Device.t()) :: {:ok, ExOnvif.PTZ.ServiceCapabilities.t()} | {:error, any()}
Returns the capabilities of the PTZ service.
@spec get_status(ExOnvif.Device.t(), String.t()) :: {:ok, ExOnvif.PTZ.Status.t()} | {:error, any()}
Operation to request PTZ status for the Node in the selected profile.