sonos-api 0.3.0

Type-safe Sonos API for UPnP device control via SOAP
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! GroupManagement service for speaker group membership operations
//!
//! This service handles group membership operations (add/remove members, track buffering)
//! for Sonos speaker groups. Operations should only be sent to the group coordinator.
//!
//! # Control Operations
//! ```rust,ignore
//! use sonos_api::services::group_management;
//!
//! let add_op = group_management::add_member("RINCON_123".to_string(), 1).build()?;
//! client.execute("192.168.1.100", add_op)?;
//! ```
//!
//! # Event Subscriptions
//! ```rust,ignore
//! let subscription = group_management::subscribe(&client, "192.168.1.100", "http://callback")?;
//! ```
//!
//! # Event Handling
//! ```rust,ignore
//! use sonos_api::services::group_management::events::{GroupManagementEventParser, create_enriched_event};
//! use sonos_api::events::EventSource;
//!
//! let parser = GroupManagementEventParser;
//! let event_data = parser.parse_upnp_event(xml_content)?;
//! let enriched = create_enriched_event(speaker_ip, event_source, event_data);
//! ```
//!
//! # Important Notes
//! - Operations should only be sent to the group coordinator

pub mod events;
pub mod operations;
pub mod state;

// Re-export operations for convenience
pub use operations::*;

// Re-export event types and parsers
pub use events::{
    create_enriched_event, create_enriched_event_with_registration_id, GroupManagementEvent,
    GroupManagementEventParser,
};
pub use state::GroupManagementState;

/// Service constant for GroupManagement
pub const SERVICE: crate::Service = crate::Service::GroupManagement;

/// Subscribe to GroupManagement events
pub fn subscribe(
    client: &crate::SonosClient,
    ip: &str,
    callback_url: &str,
) -> crate::Result<crate::ManagedSubscription> {
    client.subscribe(ip, SERVICE, callback_url)
}

/// Subscribe to GroupManagement events with custom timeout
pub fn subscribe_with_timeout(
    client: &crate::SonosClient,
    ip: &str,
    callback_url: &str,
    timeout_seconds: u32,
) -> crate::Result<crate::ManagedSubscription> {
    client.subscribe_with_timeout(ip, SERVICE, callback_url, timeout_seconds)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_module_service_constant() {
        assert_eq!(SERVICE, crate::Service::GroupManagement);
    }

    #[test]
    fn test_subscribe_function_exists() {
        // Verify subscribe function signature compiles correctly
        // This is a compile-time check - the function exists with correct types
        let _: fn(&crate::SonosClient, &str, &str) -> crate::Result<crate::ManagedSubscription> =
            subscribe;
    }

    #[test]
    fn test_subscribe_with_timeout_function_exists() {
        // Verify subscribe_with_timeout function signature compiles correctly
        let _: fn(
            &crate::SonosClient,
            &str,
            &str,
            u32,
        ) -> crate::Result<crate::ManagedSubscription> = subscribe_with_timeout;
    }
}