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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

//! Define [`PipelineElement`] which encapsulate methods
//! of [`Elements Pipeline API`][1]
//!
//! The actual element is [`GStreamer`] [`GstElement`][2] by itself
//!
//! [`GStreamer`]: https://gstreamer.freedesktop.org/
//! [1]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon_-_C_API#Elements
//! [2]: https://gstreamer.freedesktop.org/documentation/additional/design/gstelement.html
use crate::{gstd_types, resources::Pipeline, Error, GstClient};

/// Performs requests to
/// `pipelines/{name}/elements/{element}` endpoints
#[derive(Debug, Clone)]
pub struct PipelineElement {
    name: String,
    client: GstClient,
    pipeline: Pipeline,
}

impl PipelineElement {
    pub(crate) fn new<S: Into<String>>(name: S, pipeline: &Pipeline) -> Self {
        Self {
            name: name.into(),
            client: pipeline.client.clone(),
            pipeline: pipeline.clone(),
        }
    }

    /// Performs `GET pipelines/{name}/elements/
    /// {element}/properties/{property}`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn property(&self, property: &str) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .get(&format!(
                "pipelines/{}/elements/{}/properties/{property}",
                self.pipeline.name, self.name
            ))
            .await?;
        self.client.process_resp(resp).await
    }
    /// Performs `PUT pipelines/{name}/elements/
    /// {element}/properties/{property}?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 set_property(
        &self,
        property: &str,
        value: &str,
    ) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .put(&format!(
                "pipelines/{}/elements/\
            {}/properties/{property}?name={value}",
                self.pipeline.name, self.name
            ))
            .await?;
        self.client.process_resp(resp).await
    }

    /// Performs `GET pipelines/{name}/
    /// elements/{element}/signals/{signal}/callback`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn signal_connect(&self, signal: &str) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .get(&format!(
                "pipelines/{}/\
            elements/{}/signals/{signal}/callback",
                self.pipeline.name, self.name
            ))
            .await?;
        self.client.process_resp(resp).await
    }

    /// Performs `GET pipelines/{name}/
    /// elements/{element}/signals/{signal}/disconnect`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn signal_disconnect(
        &self,
        signal: &str,
    ) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .get(&format!(
                "pipelines/{}/\
            elements/{}/signals/{signal}/disconnect",
                self.pipeline.name, self.name
            ))
            .await?;
        self.client.process_resp(resp).await
    }
    /// Performs `PUT pipelines/{name}/
    /// elements/{element}/signals/{signal}/timeout?name={timeout}`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Arguments
    ///
    /// * `signal` - signal to connect
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn set_signal_timeout(
        &self,
        signal: &str,
        timeout: &str,
    ) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .put(&format!(
                "pipelines/{}/\
            elements/{}/signals/{signal}/timeout?name={timeout}",
                self.pipeline.name, self.name
            ))
            .await?;
        self.client.process_resp(resp).await
    }
}