API Reference ex_oxvif v#0.1.0

Copy Markdown View Source

Modules

ONVIF IP camera control for Elixir, backed by the Rust oxvif client.

Device management service.

Result of GetDeviceInformation.

A device that answered a WS-Discovery probe.

An error returned by any ExOxvif call.

Events service: pull-point subscriptions.

One event notification. :source and :data hold the message's SimpleItem name/value pairs.

A pull-point subscription. Pass :reference_url to ExOxvif.Events.pull_messages/3.

Imaging service: focus.

Current focus position and movement state.

Media (Media1) service: profiles and stream URIs.

A Media1 profile. Pass :token to the media and PTZ calls, and :video_source_token to the imaging calls.

A stream (RTSP) or snapshot (HTTP) URI. :timeout is an ISO 8601 duration; "PT0S" means it does not expire.

PTZ service: pan, tilt and zoom.

A PTZ configuration, as returned by GetConfigurations.

Result of GetConfigurationOptions: the accepted PTZ timeout range as ISO 8601 durations. The supported coordinate spaces and their ranges are on the node; see ExOxvif.PTZ.nodes/2.

A physical PTZ unit and the coordinate spaces it supports.

A stored PTZ preset.

A PTZ coordinate space and its range. :y_range is nil for zoom spaces.

Default PTZ speed, normalised to 0.0..1.0.

Current PTZ position and movement state. Positions are in the device's generic space: pan and tilt in -1.0..1.0, zoom in 0.0..1.0.

One entry of GetServices.

A connected ONVIF device, returned by ExOxvif.connect/2.

Result of GetSystemDateAndTime. :utc_unix is the device clock in Unix seconds, or nil when the device did not report it.