oxicast 0.0.3

Async Google Cast (Chromecast) client for Rust, built on tokio
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
96
97
98
99
100
101
102
103
104
105

//! Events emitted by a Cast device connection.

use crate::types::{IdleReason, MediaStatus, ReceiverStatus};

/// Events received from a Cast device.
///
/// Use [`CastClient::next_event()`](crate::CastClient::next_event) to receive these.
///
/// # Example
///
/// ```no_run
/// # async fn example(client: oxicast::CastClient) {
/// loop {
///     tokio::select! {
///         Some(event) = client.next_event() => match event {
///             oxicast::CastEvent::MediaStatusChanged(status) => {
///                 println!("Position: {:.1}s", status.current_time);
///             }
///             oxicast::CastEvent::Disconnected(reason) => {
///                 println!("Lost connection: {reason:?}");
///                 break;
///             }
///             _ => {}
///         },
///         _ = tokio::signal::ctrl_c() => break,
///     }
/// }
/// # }
/// ```
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum CastEvent {
    /// Successfully connected to the device.
    Connected,

    /// Connection to the device was lost.
    Disconnected(Option<String>),

    /// Attempting to reconnect after connection loss.
    Reconnecting {
        /// The current reconnection attempt number.
        attempt: u32,
    },

    /// Successfully reconnected after connection loss.
    Reconnected,

    /// The device stopped responding to heartbeat pings within the configured timeout.
    /// The connection is considered dead — auto-reconnect will trigger if enabled.
    HeartbeatTimeout,

    /// The receiver status changed (volume, running apps, etc.).
    ReceiverStatusChanged(ReceiverStatus),

    /// Media playback status changed (state, position, etc.).
    MediaStatusChanged(MediaStatus),

    /// A media session ended.
    MediaSessionEnded {
        /// The ID of the ended media session.
        media_session_id: i32,
        /// Why the session ended.
        idle_reason: IdleReason,
    },

    /// A message was received on an unhandled or custom namespace.
    RawMessage {
        /// The Cast namespace of the message.
        namespace: String,
        /// The sender ID.
        source: String,
        /// The destination ID.
        destination: String,
        /// The JSON payload.
        payload: String,
    },
}

impl CastEvent {
    /// Returns the media status if this is a `MediaStatusChanged` event.
    pub fn as_media_status(&self) -> Option<&MediaStatus> {
        match self {
            CastEvent::MediaStatusChanged(s) => Some(s),
            _ => None,
        }
    }

    /// Returns the receiver status if this is a `ReceiverStatusChanged` event.
    pub fn as_receiver_status(&self) -> Option<&ReceiverStatus> {
        match self {
            CastEvent::ReceiverStatusChanged(s) => Some(s),
            _ => None,
        }
    }

    /// Returns true if this is a disconnection event.
    pub fn is_disconnected(&self) -> bool {
        matches!(self, CastEvent::Disconnected(_))
    }

    /// Returns true if this is a media status update.
    pub fn is_media_status(&self) -> bool {
        matches!(self, CastEvent::MediaStatusChanged(_))
    }
}