oxvif 0.1.1

Async Rust client library for the ONVIF IP camera protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! # oxvif
//!
//! An async Rust client library for the [ONVIF] IP camera protocol.
//!
//! ONVIF (Open Network Video Interface Forum) is the industry standard for
//! interoperability between IP-based security products. This library covers
//! device discovery, capability negotiation, media profile management, and
//! RTSP stream URI retrieval over SOAP/HTTP(S).
//!
//! ## Architecture
//!
//! ```text
//! ┌─────────────────────────────────────────────┐
//! │               OnvifClient                   │  ← public API
//! ├─────────────────────────────────────────────┤
//! │  soap::SoapEnvelope  │  soap::WsSecurityToken│  ← SOAP layer
//! ├─────────────────────────────────────────────┤
//! │             Transport trait                 │  ← HTTP abstraction
//! │    (HttpTransport / mock in tests)          │
//! └─────────────────────────────────────────────┘
//! ```
//!
//! ## Quick Start
//!
//! ```no_run
//! use oxvif::{OnvifClient, OnvifError};
//!
//! async fn run() -> Result<(), OnvifError> {
//!     let client = OnvifClient::new("http://192.168.1.100/onvif/device_service")
//!         .with_credentials("admin", "password");
//!
//!     // Discover service endpoints
//!     let caps = client.get_capabilities().await?;
//!     let media_url = caps.media.url.as_deref().unwrap();
//!
//!     // List media profiles and get the first RTSP stream URI
//!     let profiles = client.get_profiles(media_url).await?;
//!     let uri = client.get_stream_uri(media_url, &profiles[0].token).await?;
//!
//!     println!("RTSP stream: {}", uri.uri);
//!     Ok(())
//! }
//! ```
//!
//! [ONVIF]: https://www.onvif.org

pub mod client;
pub mod discovery;
pub mod error;
pub mod soap;
pub mod transport;
pub mod types;

pub use client::OnvifClient;
pub use discovery::DiscoveredDevice;
pub use error::OnvifError;
pub use types::{
    AnalyticsCapabilities, BoundsRange, Capabilities, DeviceCapabilities, DeviceInfo,
    EncoderInstanceInfo, EventProperties, EventsCapabilities, FloatRange, H264Configuration,
    H264Options, H265Configuration, H265Options, Hostname, ImagingOptions, ImagingSettings,
    IntRange, IoCapabilities, JpegOptions, MediaCapabilities, MediaProfile, MediaProfile2,
    NetworkCapabilities, NotificationMessage, NtpInfo, OnvifService, PtzPreset, PtzStatus,
    PullPointSubscription, Resolution, SecurityCapabilities, SnapshotUri, SourceBounds, StreamUri,
    StreamingCapabilities, SystemCapabilities, SystemDateTime, VideoEncoderConfiguration,
    VideoEncoderConfiguration2, VideoEncoderConfigurationOptions,
    VideoEncoderConfigurationOptions2, VideoEncoderInstances, VideoEncoderOptions2, VideoEncoding,
    VideoRateControl, VideoRateControl2, VideoSource, VideoSourceConfiguration,
    VideoSourceConfigurationOptions,
};