ruma_events/
video.rs

Help
1//! Types for extensible video message events ([MSC3553]).
2//!
3//! [MSC3553]: https://github.com/matrix-org/matrix-spec-proposals/pull/3553
4
5use std::time::Duration;
6
7use js_int::UInt;
8use ruma_macros::EventContent;
9use serde::{Deserialize, Serialize};
10
11use super::{
12    file::{CaptionContentBlock, FileContentBlock},
13    image::ThumbnailContentBlock,
14    message::TextContentBlock,
15    room::message::Relation,
16};
17
18/// The payload for an extensible video message.
19///
20/// This is the new primary type introduced in [MSC3553] and should only be sent in rooms with a
21/// version that supports it. See the documentation of the [`message`] module for more information.
22///
23/// [MSC3553]: https://github.com/matrix-org/matrix-spec-proposals/pull/3553
24/// [`message`]: super::message
25#[derive(Clone, Debug, Serialize, Deserialize, EventContent)]
26#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
27#[ruma_event(type = "org.matrix.msc1767.video", kind = MessageLike, without_relation)]
28pub struct VideoEventContent {
29    /// The text representation of the message.
30    #[serde(rename = "org.matrix.msc1767.text")]
31    pub text: TextContentBlock,
32
33    /// The file content of the message.
34    #[serde(rename = "org.matrix.msc1767.file")]
35    pub file: FileContentBlock,
36
37    /// The video details of the message, if any.
38    #[serde(rename = "org.matrix.msc1767.video_details", skip_serializing_if = "Option::is_none")]
39    pub video_details: Option<VideoDetailsContentBlock>,
40
41    /// The thumbnails of the message, if any.
42    ///
43    /// This is optional and defaults to an empty array.
44    #[serde(
45        rename = "org.matrix.msc1767.thumbnail",
46        default,
47        skip_serializing_if = "ThumbnailContentBlock::is_empty"
48    )]
49    pub thumbnail: ThumbnailContentBlock,
50
51    /// The caption of the message, if any.
52    #[serde(rename = "org.matrix.msc1767.caption", skip_serializing_if = "Option::is_none")]
53    pub caption: Option<CaptionContentBlock>,
54
55    /// Whether this message is automated.
56    #[cfg(feature = "unstable-msc3955")]
57    #[serde(
58        default,
59        skip_serializing_if = "ruma_common::serde::is_default",
60        rename = "org.matrix.msc1767.automated"
61    )]
62    pub automated: bool,
63
64    /// Information about related messages.
65    #[serde(
66        flatten,
67        skip_serializing_if = "Option::is_none",
68        deserialize_with = "crate::room::message::relation_serde::deserialize_relation"
69    )]
70    pub relates_to: Option<Relation<VideoEventContentWithoutRelation>>,
71}
72
73impl VideoEventContent {
74    /// Creates a new `VideoEventContent` with the given fallback representation and file.
75    pub fn new(text: TextContentBlock, file: FileContentBlock) -> Self {
76        Self {
77            text,
78            file,
79            video_details: None,
80            thumbnail: Default::default(),
81            caption: None,
82            #[cfg(feature = "unstable-msc3955")]
83            automated: false,
84            relates_to: None,
85        }
86    }
87
88    /// Creates a new `VideoEventContent` with the given plain text fallback representation and
89    /// file.
90    pub fn with_plain_text(plain_text: impl Into<String>, file: FileContentBlock) -> Self {
91        Self {
92            text: TextContentBlock::plain(plain_text),
93            file,
94            video_details: None,
95            thumbnail: Default::default(),
96            caption: None,
97            #[cfg(feature = "unstable-msc3955")]
98            automated: false,
99            relates_to: None,
100        }
101    }
102}
103
104/// A block for details of video content.
105#[derive(Clone, Debug, Serialize, Deserialize)]
106#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
107pub struct VideoDetailsContentBlock {
108    /// The width of the video in pixels.
109    pub width: UInt,
110
111    /// The height of the video in pixels.
112    pub height: UInt,
113
114    /// The duration of the video in seconds.
115    #[serde(
116        with = "ruma_common::serde::duration::opt_secs",
117        default,
118        skip_serializing_if = "Option::is_none"
119    )]
120    pub duration: Option<Duration>,
121}
122
123impl VideoDetailsContentBlock {
124    /// Creates a new `VideoDetailsContentBlock` with the given height and width.
125    pub fn new(width: UInt, height: UInt) -> Self {
126        Self { width, height, duration: None }
127    }
128}
ruma_events/video.rs

ruma_events/
video.rs
