gst-client 0.2.1

Provides bindings for the main functionalities of the GStreamer Daemon
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

//! Define [`struct@Debug`] which encapsulate methods
//! of [`Debug API`][1] for [`GStreamer`][2]
//!
//! Details about [`GStreamer Debugging`]
//!
//! [GStreamer]: https://gstreamer.freedesktop.org/
//! [1]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon_-_C_API#Debug
//! [2]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Debugging
use crate::{gstd_types, Error, GstClient};

/// Performs requests to `debug/` endpoint
#[derive(Debug, Clone)]
pub struct Debug {
    client: GstClient,
}

impl Debug {
    pub(crate) fn new(client: &GstClient) -> Self {
        Self {
            client: client.clone(),
        }
    }
    /// Performs `PUT debug/enable?name=enable`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn enable(&self) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self.client.put("debug/enable?name=true").await?;
        self.client.process_resp(resp).await
    }

    /// Performs `PUT debug/enable?name=false`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn disable(&self) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self.client.put("debug/enable?name=false").await?;
        self.client.process_resp(resp).await
    }

    /// Performs `PUT debug/reset?name={value}`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn reset(&self, value: bool) -> Result<gstd_types::SuccessResponse, Error> {
        let val = if value { "true" } else { "false" };
        let resp = self.client.put(&format!("debug/reset?name={val}")).await?;
        self.client.process_resp(resp).await
    }
    /// Performs `PUT debug/threshold?name={value}`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn threshold(&self, value: &str) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .put(&format!("debug/threshold?name={value}"))
            .await?;
        self.client.process_resp(resp).await
    }
    /// Performs `PUT debug/color?name=true`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn enable_color(&self) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self.client.put("debug/color?name=true").await?;
        self.client.process_resp(resp).await
    }
    /// Performs `PUT debug/color?name=false`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn disable_color(&self) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self.client.put("debug/color?name=false").await?;
        self.client.process_resp(resp).await
    }
}