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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! [`GStreamer Daemon HTTP`][1] API structures.
//!
//! [1]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon_-_HTTP_API
#![allow(unreachable_pub, missing_docs)]

use derive_more::{Display, Error};
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};

/// Response returned by [`GStreamer Daemon`][1] API.
///
/// [1]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(untagged)]
pub enum ApiResponse {
    Success(SuccessResponse),
    Error(ErrorResponse),
}

/// Successful response by [`GStreamer Daemon`][1] API.
///
/// [1]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SuccessResponse {
    pub code: ResponseCode,
    /// Description of command response.
    /// Same as [`SuccessResponse::code`] but with text
    pub description: String,
    /// The actual response data from the server
    pub response: ResponseT,
}

/// Unsuccessful response by [`GStreamer Daemon`][1] API.
///
/// [1]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ErrorResponse {
    pub code: ResponseCode,
    pub description: String,
    pub response: Option<()>,
}

/// Response Codes for [`SuccessResponse`] of [`GStD`]
///
/// [`GStD`]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon
#[derive(Serialize_repr, Deserialize_repr, PartialEq, Eq, Debug, Clone, Copy, Error, Display)]
#[repr(u8)]
pub enum ResponseCode {
    ///Everything went OK
    Success = 0,
    /// A mandatory argument was passed NULL
    NullArgument = 1,
    /// A bad pipeline description was provided
    BadDescription = 2,
    /// The name trying to be used already exists
    ExistingName = 3,
    /// Missing initialization
    MissingInitialization = 4,
    /// The requested pipeline was not found
    NoPipeline = 5,
    /// The requested resource was not found
    NoResource = 6,
    /// Cannot create a resource in the given property
    NoCreate = 7,
    /// The resource to create already exists
    ExistingResource = 8,
    /// Cannot update the given property
    NoUpdate = 9,
    /// Unknown command
    BadCommand = 10,
    /// Cannot read the given resource
    NoRead = 11,
    ///Cannot connect
    NoConnection = 12,
    /// The given value is incorrect
    BadValue = 13,
    /// Failed to change state of a pipeline
    StateError = 14,
    /// Failed to start IPC
    IpcError = 15,
    /// Unknown event
    EventError = 16,
    /// Incomplete arguments in user input
    MissingArgument = 17,
    /// Missing name of the pipeline
    MissingName = 18,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(untagged)]
pub enum ResponseT {
    Bus(Option<Bus>),
    PropertiesWithNodes(PropertiesWithNodes),
    Properties(Properties),
    Property(Property),
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Param {
    pub description: String,
    pub r#type: String,
    pub access: String,
}

/// Possible result in [`SuccessResponse::response`] after
/// `GET /pipelines` API request
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PropertiesWithNodes {
    pub properties: Vec<Property>,
    pub nodes: Vec<Node>,
}

/// Possible result in [`SuccessResponse::response`] after
/// `GET /pipelines/{{pipeline_name}}/graph` API request
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Properties {
    pub properties: Vec<Property>,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Node {
    /// The name of [`GStreamer element`]
    ///
    /// [`GStreamer element`]: https://gstreamer.freedesktop.org/documentation/
    /// application-development/basics/elements.html
    pub name: String,
}

/// Possible result in [`SuccessResponse::response`] after
/// `GET /pipelines/{pipeline_name}/graph` API request
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Property {
    pub name: String,
    pub value: PropertyValue,
    pub param: Param,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(untagged)]
pub enum PropertyValue {
    String(String),
    Integer(i32),
    Bool(bool),
}

/// Possible result in [`SuccessResponse::response`] after
/// `GET /pipelines/{name}/bus/message` API request
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Bus {
    pub r#type: String,
    pub source: String,
    pub timestamp: String,
    pub seqnum: i64,
    pub message: String,
    pub debug: String,
}