srs-client 0.2.1

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

//! [HTTP Callback API][1] of [SRS] exposed by application.
//!
//! [SRS]: https://ossrs.io/
//! [1]: https://ossrs.io/lts/en-us/docs/v5/doc/http-callback

use std::net::IpAddr;

use super::SrsCallbackEvent;
use serde::{Deserialize, Serialize};

/// Request performed by [SRS] to [HTTP Callback API][1].
///
/// [SRS]: https://ossrs.io/
/// [1]: https://ossrs.io/lts/en-us/docs/v5/doc/http-callback
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SrsCallbackReq {
    /// ID of the [SRS] server
    ///
    /// [SRS]: https://ossrs.io/
    pub server_id: String,

    /// Event that [SRS] reports about.
    ///
    /// [SRS]: https://ossrs.io/
    pub action: SrsCallbackEvent,

    /// ID of [SRS] client that happened event is related to.
    ///
    /// [SRS]: https://ossrs.io/
    pub client_id: String,

    /// IP address of [SRS] client that happened event is related to.
    ///
    /// [SRS]: https://ossrs.io/
    pub ip: IpAddr,

    /// [SRS] `vhost` ([virtual host][1]) of RTMP stream that happened event is
    /// related to.
    ///
    /// [SRS]: https://ossrs.io/
    /// [1]: https://github.com/ossrs/srs/wiki/migrate_v4_EN_rtmp-url-vhost
    pub vhost: String,

    /// [SRS] `app` of RTMP stream that happened event is related to.
    ///
    /// [SRS]: https://ossrs.io/
    pub app: String,

    /// [SRS] `stream` of RTMP stream that happened event is related to.
    ///
    /// [SRS]: https://ossrs.io/
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub stream: Option<String>,
}

impl SrsCallbackReq {
    /// Combine [`SrsCallbackReq::app`] and [`SrsCallbackReq::stream`] fields.
    /// Uses for tracing
    #[allow(dead_code)]
    #[must_use]
    pub fn app_stream(&self) -> String {
        if let Some(stream) = &self.stream {
            format!("{}/{}", self.app, stream)
        } else {
            self.app.clone()
        }
    }
}