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

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

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

impl PipelineBus {
    pub(crate) fn new(pipeline: &Pipeline) -> Self {
        Self {
            pipeline: pipeline.clone(),
            client: pipeline.client.clone(),
        }
    }
    /// Performs `GET pipelines/{name}/bus/message`
    /// API request, returning the parsed [`gstd_types::SuccessResponse`]
    ///
    /// # Errors
    ///
    /// If API request cannot be performed, or fails.
    /// See [`Error`] for details.
    pub async fn read(&self) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .get(&format!("pipelines/{}/bus/message", self.pipeline.name))
            .await?;
        self.client.process_resp(resp).await
    }
    /// Performs `PUT pipelines/{name}?timeout={time_ns}`
    /// 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_timeout(&self, time_ns: i32) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .put(&format!(
                "pipelines/{}/bus/timeout?name={time_ns}",
                self.pipeline.name
            ))
            .await?;
        self.client.process_resp(resp).await
    }
    /// Performs `PUT pipelines/{name}?types={filter}`
    /// 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_filter(&self, filter: &str) -> Result<gstd_types::SuccessResponse, Error> {
        let resp = self
            .client
            .put(&format!(
                "pipelines/{}/bus/types?name={filter}",
                self.pipeline.name
            ))
            .await?;
        self.client.process_resp(resp).await
    }
}