ruma_events/
call.rs

1//! Modules for events in the `m.call` namespace.
2//!
3//! This module also contains types shared by events in its child namespaces.
4
5pub mod answer;
6pub mod candidates;
7pub mod hangup;
8pub mod invite;
9#[cfg(feature = "unstable-msc3401")]
10pub mod member;
11pub mod negotiate;
12#[cfg(feature = "unstable-msc4075")]
13pub mod notify;
14pub mod reject;
15pub mod sdp_stream_metadata_changed;
16pub mod select_answer;
17
18use ruma_macros::StringEnum;
19use serde::{Deserialize, Serialize};
20
21use crate::PrivOwnedStr;
22
23/// A VoIP session description.
24///
25/// This is the same type as WebRTC's [`RTCSessionDescriptionInit`].
26///
27/// [`RTCSessionDescriptionInit`]: (https://www.w3.org/TR/webrtc/#dom-rtcsessiondescriptioninit):
28#[derive(Clone, Debug, Deserialize, Serialize)]
29#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
30pub struct SessionDescription {
31    /// The type of session description.
32    ///
33    /// This is the `type` field of `RTCSessionDescriptionInit`.
34    #[serde(rename = "type")]
35    pub session_type: String,
36
37    /// The SDP text of the session description.
38    ///
39    /// Defaults to an empty string.
40    #[serde(default)]
41    pub sdp: String,
42}
43
44impl SessionDescription {
45    /// Creates a new `SessionDescription` with the given session type and SDP text.
46    pub fn new(session_type: String, sdp: String) -> Self {
47        Self { session_type, sdp }
48    }
49}
50
51/// Metadata about a VoIP stream.
52#[derive(Clone, Debug, Serialize, Deserialize)]
53#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
54pub struct StreamMetadata {
55    /// The purpose of the stream.
56    pub purpose: StreamPurpose,
57
58    /// Whether the audio track of the stream is muted.
59    ///
60    /// Defaults to `false`.
61    #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
62    pub audio_muted: bool,
63
64    /// Whether the video track of the stream is muted.
65    ///
66    /// Defaults to `false`.
67    #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
68    pub video_muted: bool,
69}
70
71impl StreamMetadata {
72    /// Creates a new `StreamMetadata` with the given purpose.
73    pub fn new(purpose: StreamPurpose) -> Self {
74        Self { purpose, audio_muted: false, video_muted: false }
75    }
76}
77
78/// The purpose of a VoIP stream.
79#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
80#[derive(Clone, PartialEq, Eq, StringEnum)]
81#[ruma_enum(rename_all = "m.lowercase")]
82#[non_exhaustive]
83pub enum StreamPurpose {
84    /// `m.usermedia`.
85    ///
86    /// A stream that contains the webcam and/or microphone tracks.
87    UserMedia,
88
89    /// `m.screenshare`.
90    ///
91    /// A stream with the screen-sharing tracks.
92    ScreenShare,
93
94    #[doc(hidden)]
95    _Custom(PrivOwnedStr),
96}
97
98/// The capabilities of a client in a VoIP call.
99#[cfg(feature = "unstable-msc2747")]
100#[derive(Clone, Debug, Default, Serialize, Deserialize)]
101#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
102pub struct CallCapabilities {
103    /// Whether this client supports [DTMF].
104    ///
105    /// Defaults to `false`.
106    ///
107    /// [DTMF]: https://w3c.github.io/webrtc-pc/#peer-to-peer-dtmf
108    #[serde(rename = "m.call.dtmf", default)]
109    pub dtmf: bool,
110}
111
112#[cfg(feature = "unstable-msc2747")]
113impl CallCapabilities {
114    /// Creates a default `CallCapabilities`.
115    pub fn new() -> Self {
116        Self::default()
117    }
118
119    /// Whether this `CallCapabilities` only contains default values.
120    pub fn is_default(&self) -> bool {
121        !self.dtmf
122    }
123}
ruma_events/call.rs

ruma_events/
call.rs
