ruma_events/call/
negotiate.rs

Help
1//! Types for the [`m.call.negotiate`] event.
2//!
3//! [`m.call.negotiate`]: https://spec.matrix.org/latest/client-server-api/#mcallnegotiate
4
5use std::collections::BTreeMap;
6
7use js_int::UInt;
8use ruma_common::{OwnedVoipId, VoipVersionId};
9use ruma_macros::EventContent;
10use serde::{Deserialize, Serialize};
11
12use super::{SessionDescription, StreamMetadata};
13
14/// **Added in VoIP version 1.** The content of an `m.call.negotiate` event.
15///
16/// This event is sent by either party after the call is established to renegotiate it. It can be
17/// used for media pause, hold/resume, ICE restarts and voice/video call up/downgrading.
18///
19/// First an event must be sent with an `offer` session description, which is replied to with an
20/// event with an `answer` session description.
21#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
22#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
23#[ruma_event(type = "m.call.negotiate", kind = MessageLike)]
24pub struct CallNegotiateEventContent {
25    /// The ID of the call this event relates to.
26    pub call_id: OwnedVoipId,
27
28    /// The unique ID for this session for the duration of the call.
29    ///
30    /// Must be the same as the one sent by the previous invite or answer from
31    /// this session.
32    pub party_id: OwnedVoipId,
33
34    /// The version of the VoIP specification this messages adheres to.
35    pub version: VoipVersionId,
36
37    /// The time in milliseconds that the negotiation is valid for.
38    pub lifetime: UInt,
39
40    /// The session description of the negotiation.
41    pub description: SessionDescription,
42
43    /// Metadata describing the streams that will be sent.
44    ///
45    /// This is a map of stream ID to metadata about the stream.
46    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
47    pub sdp_stream_metadata: BTreeMap<String, StreamMetadata>,
48}
49
50impl CallNegotiateEventContent {
51    /// Creates a `CallNegotiateEventContent` with the given call ID, party ID, lifetime and
52    /// description.
53    pub fn new(
54        call_id: OwnedVoipId,
55        party_id: OwnedVoipId,
56        version: VoipVersionId,
57        lifetime: UInt,
58        description: SessionDescription,
59    ) -> Self {
60        Self {
61            call_id,
62            party_id,
63            version,
64            lifetime,
65            description,
66            sdp_stream_metadata: Default::default(),
67        }
68    }
69
70    /// Convenience method to create a version 1 `CallNegotiateEventContent` with all the required
71    /// fields.
72    pub fn version_1(
73        call_id: OwnedVoipId,
74        party_id: OwnedVoipId,
75        lifetime: UInt,
76        description: SessionDescription,
77    ) -> Self {
78        Self::new(call_id, party_id, VoipVersionId::V1, lifetime, description)
79    }
80}
ruma_events/call/negotiate.rs

ruma_events/call/
negotiate.rs
