kdeconnect-proto 0.2.0

A pure Rust modular implementation of the KDE Connect 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
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

//! The SystemVolume plugin allows sharing volume controls between devices.
use serde::{Deserialize, Serialize};

#[cfg(not(feature = "std"))]
use alloc::{string::String, vec::Vec};

/// An audio stream object.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct SystemVolumeStream {
    /// The stream name.
    pub name: String,

    /// The stream display name.
    pub description: String,

    /// Whether the stream is enabled.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub enabled: Option<bool>,

    /// Whether the stream is muted.
    pub muted: bool,

    /// The stream max volume level.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub max_volume: Option<u64>,

    /// The stream volume level.
    pub volume: u64,
}

/// This packet is a mixer stream state update.
///
/// <https://invent.kde.org/network/kdeconnect-meta/blob/master/protocol.md#kdeconnectsystemvolume>
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct SystemVolumePacket {
    /// The list of audio streams.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub sink_list: Option<Vec<SystemVolumeStream>>,

    /// The stream name.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub name: Option<String>,

    /// Whether the stream is enabled.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub enabled: Option<bool>,

    /// Whether the stream is muted.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub muted: Option<bool>,

    /// The stream volume level.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub volume: Option<u64>,
}

/// This packet is a audio stream request. It is used to request both the list of streams and changes to those streams.
///
/// <https://invent.kde.org/network/kdeconnect-meta/blob/master/protocol.md#kdeconnectsystemvolumerequest>
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct SystemVolumeRequestPacket {
    /// Indicates this is a request for the stream list.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub request_sinks: Option<bool>,

    /// The name of a stream. If the packet contains this field, it is a request to adjust a stream.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub name: Option<String>,

    /// Indicates the stream should become the active default. Always true if present.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub enabled: Option<bool>,

    /// The requested mute state.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub muted: Option<bool>,

    /// The requested volume. The maximum value is provided by the maxVolume field of the stream.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub volume: Option<u64>,
}