ruma_events/call/
answer.rs

Help
1//! Types for the [`m.call.answer`] event.
2//!
3//! [`m.call.answer`]: https://spec.matrix.org/latest/client-server-api/#mcallanswer
4
5use std::collections::BTreeMap;
6
7use ruma_common::{OwnedVoipId, VoipVersionId};
8use ruma_macros::EventContent;
9use serde::{Deserialize, Serialize};
10
11#[cfg(feature = "unstable-msc2747")]
12use super::CallCapabilities;
13use super::{SessionDescription, StreamMetadata};
14
15/// The content of an `m.call.answer` event.
16///
17/// This event is sent by the callee when they wish to answer the call.
18#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
19#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
20#[ruma_event(type = "m.call.answer", kind = MessageLike)]
21pub struct CallAnswerEventContent {
22    /// The VoIP session description object.
23    pub answer: SessionDescription,
24
25    /// A unique identifier for the call.
26    pub call_id: OwnedVoipId,
27
28    /// **Required in VoIP version 1.** A unique ID for this session for the duration of the call.
29    #[serde(skip_serializing_if = "Option::is_none")]
30    pub party_id: Option<OwnedVoipId>,
31
32    /// The version of the VoIP specification this messages adheres to.
33    pub version: VoipVersionId,
34
35    #[cfg(feature = "unstable-msc2747")]
36    /// The VoIP capabilities of the client.
37    #[serde(default, skip_serializing_if = "CallCapabilities::is_default")]
38    pub capabilities: CallCapabilities,
39
40    /// **Added in VoIP version 1.** Metadata describing the streams that will be sent.
41    ///
42    /// This is a map of stream ID to metadata about the stream.
43    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
44    pub sdp_stream_metadata: BTreeMap<String, StreamMetadata>,
45}
46
47impl CallAnswerEventContent {
48    /// Creates an `CallAnswerEventContent` with the given answer, call ID and VoIP version.
49    pub fn new(answer: SessionDescription, call_id: OwnedVoipId, version: VoipVersionId) -> Self {
50        Self {
51            answer,
52            call_id,
53            party_id: None,
54            version,
55            #[cfg(feature = "unstable-msc2747")]
56            capabilities: Default::default(),
57            sdp_stream_metadata: Default::default(),
58        }
59    }
60
61    /// Convenience method to create a VoIP version 0 `CallAnswerEventContent` with all the required
62    /// fields.
63    pub fn version_0(answer: SessionDescription, call_id: OwnedVoipId) -> Self {
64        Self::new(answer, call_id, VoipVersionId::V0)
65    }
66
67    /// Convenience method to create a VoIP version 1 `CallAnswerEventContent` with all the required
68    /// fields.
69    pub fn version_1(
70        answer: SessionDescription,
71        call_id: OwnedVoipId,
72        party_id: OwnedVoipId,
73    ) -> Self {
74        Self {
75            answer,
76            call_id,
77            party_id: Some(party_id),
78            version: VoipVersionId::V1,
79            #[cfg(feature = "unstable-msc2747")]
80            capabilities: Default::default(),
81            sdp_stream_metadata: Default::default(),
82        }
83    }
84}
ruma_events/call/answer.rs

ruma_events/call/
answer.rs
