ruma_events/call/member/
focus.rs

Help
1//! Types for MatrixRTC Focus/SFU configurations.
2
3use ruma_macros::StringEnum;
4use serde::{Deserialize, Serialize};
5
6use crate::PrivOwnedStr;
7
8/// Description of the SFU/Focus a membership can be connected to.
9///
10/// A focus can be any server powering the MatrixRTC session (SFU,
11/// MCU). It serves as a node to redistribute RTC streams.
12#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
13#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
14#[serde(tag = "type", rename_all = "snake_case")]
15pub enum Focus {
16    /// LiveKit is one possible type of SFU/Focus that can be used for a MatrixRTC session.
17    Livekit(LivekitFocus),
18}
19
20/// The struct to describe LiveKit as a `preferred_foci`.
21#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
22#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
23pub struct LivekitFocus {
24    /// The alias where the LiveKit sessions can be reached.
25    #[serde(rename = "livekit_alias")]
26    pub alias: String,
27
28    /// The URL of the JWT service for the LiveKit instance.
29    #[serde(rename = "livekit_service_url")]
30    pub service_url: String,
31}
32
33impl LivekitFocus {
34    /// Initialize a [`LivekitFocus`].
35    ///
36    /// # Arguments
37    ///
38    /// * `alias` - The alias with which the LiveKit sessions can be reached.
39    /// * `service_url` - The url of the JWT server for the LiveKit instance.
40    pub fn new(alias: String, service_url: String) -> Self {
41        Self { alias, service_url }
42    }
43}
44
45/// Data to define the actively used Focus.
46///
47/// A focus can be any server powering the MatrixRTC session (SFU,
48/// MCU). It serves as a node to redistribute RTC streams.
49#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
50#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
51#[serde(tag = "type", rename_all = "snake_case")]
52pub enum ActiveFocus {
53    /// LiveKit is one possible type of SFU/Focus that can be used for a MatrixRTC session.
54    Livekit(ActiveLivekitFocus),
55}
56
57/// The fields to describe the `active_foci`.
58#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
59#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
60pub struct ActiveLivekitFocus {
61    /// The selection method used to select the LiveKit focus for the rtc session.
62    pub focus_selection: FocusSelection,
63}
64
65impl ActiveLivekitFocus {
66    /// Initialize a [`ActiveLivekitFocus`].
67    ///
68    /// # Arguments
69    ///
70    /// * `focus_selection` - The selection method used to select the LiveKit focus for the rtc
71    ///   session.
72    pub fn new() -> Self {
73        Self { focus_selection: FocusSelection::OldestMembership }
74    }
75}
76
77/// How to select the active focus for LiveKit
78#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
79#[derive(Clone, PartialEq, StringEnum)]
80#[ruma_enum(rename_all = "snake_case")]
81#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
82pub enum FocusSelection {
83    /// Select the active focus by using the oldest membership and the oldest focus.
84    OldestMembership,
85
86    #[doc(hidden)]
87    _Custom(PrivOwnedStr),
88}
ruma_events/call/member/focus.rs

ruma_events/call/member/
focus.rs
