apprtc 0.4.0

AppRTC P2P/SFU Server in Rust
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

use serde::Serialize;

/// The synthetic peer added in loopback debug mode (was
/// `constants.LOOPBACK_CLIENT_ID`).
pub const LOOPBACK_CLIENT_ID: &str = "LOOPBACK_CLIENT_ID";

/// Mirrors a single entry of the `RTCConfiguration.iceServers` array.
#[derive(Debug, Clone, Default, Serialize)]
pub struct IceServer {
    pub urls: Vec<String>,
    #[serde(skip_serializing_if = "String::is_empty")]
    pub username: String,
    #[serde(skip_serializing_if = "String::is_empty")]
    pub credential: String,
}

/// Holds the server configuration that used to live in the App Engine room
/// server (`constants.py` + `app.yaml` env_variables). It is populated from
/// flags/env by the binary entry point and consumed by the room server handlers.
#[derive(Debug, Clone, Default)]
pub struct Config {
    /// Path to the `web_app/` directory served as static assets.
    pub web_root: String,

    /// If set, overrides the public host:port used to build self URLs
    /// (`wss_url`/`wss_post_url`/`room_link`). When empty the request Host is used.
    pub host: String,

    /// If true, builds https/wss self URLs even when the incoming request looks
    /// like plain HTTP (e.g. behind a TLS-terminating proxy).
    pub force_tls: bool,

    /// Complete public signaling WebSocket URL ending in `/ws` (for split
    /// AppRTC/Signaling deployments). When empty, the AppRTC origin is used.
    pub signaling_ws_url: String,

    /// If non-empty, returned verbatim from `/v1alpha/iceconfig` and used as the
    /// `iceServers` of the peer connection config (was `constants.ICE_SERVER_OVERRIDE`).
    pub ice_server_override: Vec<IceServer>,

    /// The list of ICE urls returned from `/v1alpha/iceconfig` when no override is
    /// set (was `constants.ICE_SERVER_URLS`).
    pub ice_server_urls: Vec<String>,

    /// The origin of the ICE server provider used to build `ice_server_url`. When
    /// empty, the server's own origin is used so the page fetches
    /// `/v1alpha/iceconfig` from this binary.
    pub ice_server_base_url: String,

    /// The api key appended to `ice_server_url`.
    pub ice_server_api_key: String,

    /// An optional banner shown on every page (was `HEADER_MESSAGE`).
    pub header_message: String,

    /// Skips the "Ready to join?" prompt (was `BYPASS_JOIN_CONFIRMATION`).
    pub bypass_join_confirmation: bool,
}