RuStream 1.4.0

Self-hosted Streaming Engine, that can render media files via authenticated sessions.
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

use std::{path, thread};
use std::collections::HashMap;
use std::net::ToSocketAddrs;

/// Represents the configuration parameters for RuStream.
pub struct Config {
    /// Dictionary of key-value pairs for authorization (username and password).
    pub authorization: HashMap<String, String>,
    /// Source path for media files.
    pub media_source: path::PathBuf,

    /// Debug flag to enable debug level logging.
    pub debug: bool,
    /// Boolean flag to enable UTC timezone in logging. Defaults to local timezone.
    pub utc_logging: bool,
    /// Host IP address for media streaming.
    pub media_host: String,
    /// Port number for hosting the application.
    pub media_port: u16,
    /// Duration of a session in seconds.
    pub session_duration: i64,
    /// List of supported file formats.
    pub file_formats: Vec<String>,

    /// Number of worker threads to spin up the server.
    pub workers: usize,
    /// Maximum number of concurrent connections.
    pub max_connections: usize,
    /// Max payload allowed by the server in request body.
    pub max_payload_size: usize,
    /// List of websites (supports regex) to add to CORS configuration.
    pub websites: Vec<String>,

    /// Boolean flag to restrict session_token to be sent only via HTTPS
    pub secure_session: bool,

    /// Path to the private key file for SSL certificate
    pub key_file: path::PathBuf,
    /// Path to the full certificate chain file for SSL certificate
    pub cert_file: path::PathBuf,
}

/// Returns the default value for debug flag.
pub fn default_debug() -> bool { false }

/// Returns the default value for UTC logging.
pub fn default_utc_logging() -> bool { true }

/// Returns the default value for SSL files.
pub fn default_ssl() -> path::PathBuf { path::PathBuf::new() }

/// Returns the default media host based on the local machine's IP address.
pub fn default_media_host() -> String {
    let hostname = "localhost";
    match (hostname, 0).to_socket_addrs() {
        Ok(mut addrs) => {
            if let Some(addr) = addrs.find(|a| a.is_ipv4()) {
                return addr.ip().to_string();
            }
        }
        Err(err) => {
            log::error!("Error resolving hostname: {}", err);
        }
    }
    "localhost".to_string()
}

/// Returns the default media port (8000)
pub fn default_media_port() -> u16 { 8000 }

/// Returns the default session duration (3600 seconds)
pub fn default_session_duration() -> i64 { 3600 }

/// Returns the file formats supported by default.
pub fn default_file_formats() -> Vec<String> {
    vec!["mp4".to_string(), "mov".to_string(), "jpg".to_string(), "jpeg".to_string()]
}

/// Returns the default number of worker threads (half of logical cores)
pub fn default_workers() -> usize {
    let logical_cores = thread::available_parallelism();
    match logical_cores {
        Ok(cores) => cores.get() / 2,
        Err(err) => {
            log::error!("{}", err);
            3
        }
    }
}

/// Returns the default maximum number of concurrent connections (3)
pub fn default_max_connections() -> usize { 3 }

/// Returns the default max payload size (100 MB)
pub fn default_max_payload_size() -> usize { 100 * 1024 * 1024 }

/// Returns an empty list as the default website (CORS configuration)
pub fn default_websites() -> Vec<String> { Vec::new() }

/// Returns the default value for secure_session
pub fn default_secure_session() -> bool { false }