ruma_events/room/message/
video.rs

Help
1use std::time::Duration;
2
3use js_int::UInt;
4use ruma_common::OwnedMxcUri;
5use serde::{Deserialize, Serialize};
6
7use super::FormattedBody;
8use crate::room::{
9    message::media_caption::{caption, formatted_caption},
10    EncryptedFile, MediaSource, ThumbnailInfo,
11};
12
13/// The payload for a video message.
14#[derive(Clone, Debug, Deserialize, Serialize)]
15#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
16pub struct VideoMessageEventContent {
17    /// A description of the video.
18    ///
19    /// If the `filename` field is not set or has the same value, this is the filename of the
20    /// uploaded file. Otherwise, this should be interpreted as a user-written media caption.
21    pub body: String,
22
23    /// Formatted form of the message `body`.
24    ///
25    /// This should only be set if the body represents a caption.
26    #[serde(flatten)]
27    pub formatted: Option<FormattedBody>,
28
29    /// The original filename of the uploaded file as deserialized from the event.
30    ///
31    /// It is recommended to use the `filename` method to get the filename which automatically
32    /// falls back to the `body` field when the `filename` field is not set.
33    #[serde(skip_serializing_if = "Option::is_none")]
34    pub filename: Option<String>,
35
36    /// The source of the video clip.
37    #[serde(flatten)]
38    pub source: MediaSource,
39
40    /// Metadata about the video clip referred to in `source`.
41    #[serde(skip_serializing_if = "Option::is_none")]
42    pub info: Option<Box<VideoInfo>>,
43}
44
45impl VideoMessageEventContent {
46    /// Creates a new `VideoMessageEventContent` with the given body and source.
47    pub fn new(body: String, source: MediaSource) -> Self {
48        Self { body, formatted: None, filename: None, source, info: None }
49    }
50
51    /// Creates a new non-encrypted `VideoMessageEventContent` with the given body and url.
52    pub fn plain(body: String, url: OwnedMxcUri) -> Self {
53        Self::new(body, MediaSource::Plain(url))
54    }
55
56    /// Creates a new encrypted `VideoMessageEventContent` with the given body and encrypted
57    /// file.
58    pub fn encrypted(body: String, file: EncryptedFile) -> Self {
59        Self::new(body, MediaSource::Encrypted(Box::new(file)))
60    }
61
62    /// Creates a new `VideoMessageEventContent` from `self` with the `info` field set to the given
63    /// value.
64    ///
65    /// Since the field is public, you can also assign to it directly. This method merely acts
66    /// as a shorthand for that, because it is very common to set this field.
67    pub fn info(self, info: impl Into<Option<Box<VideoInfo>>>) -> Self {
68        Self { info: info.into(), ..self }
69    }
70
71    /// Computes the filename of the video as defined by the [spec](https://spec.matrix.org/latest/client-server-api/#media-captions).
72    ///
73    /// This differs from the `filename` field as this method falls back to the `body` field when
74    /// the `filename` field is not set.
75    pub fn filename(&self) -> &str {
76        self.filename.as_deref().unwrap_or(&self.body)
77    }
78
79    /// Returns the caption of the video as defined by the [spec](https://spec.matrix.org/latest/client-server-api/#media-captions).
80    ///
81    /// In short, this is the `body` field if the `filename` field exists and has a different value,
82    /// otherwise the media file does not have a caption.
83    pub fn caption(&self) -> Option<&str> {
84        caption(&self.body, self.filename.as_deref())
85    }
86
87    /// Returns the formatted caption of the video as defined by the [spec](https://spec.matrix.org/latest/client-server-api/#media-captions).
88    ///
89    /// This is the same as `caption`, but returns the formatted body instead of the plain body.
90    pub fn formatted_caption(&self) -> Option<&FormattedBody> {
91        formatted_caption(&self.body, self.formatted.as_ref(), self.filename.as_deref())
92    }
93}
94
95/// Metadata about a video.
96#[derive(Clone, Debug, Default, Deserialize, Serialize)]
97#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
98pub struct VideoInfo {
99    /// The duration of the video in milliseconds.
100    #[serde(
101        with = "ruma_common::serde::duration::opt_ms",
102        default,
103        skip_serializing_if = "Option::is_none"
104    )]
105    pub duration: Option<Duration>,
106
107    /// The height of the video in pixels.
108    #[serde(rename = "h", skip_serializing_if = "Option::is_none")]
109    pub height: Option<UInt>,
110
111    /// The width of the video in pixels.
112    #[serde(rename = "w", skip_serializing_if = "Option::is_none")]
113    pub width: Option<UInt>,
114
115    /// The mimetype of the video, e.g. "video/mp4".
116    #[serde(skip_serializing_if = "Option::is_none")]
117    pub mimetype: Option<String>,
118
119    /// The size of the video in bytes.
120    #[serde(skip_serializing_if = "Option::is_none")]
121    pub size: Option<UInt>,
122
123    /// Metadata about the image referred to in `thumbnail_source`.
124    #[serde(skip_serializing_if = "Option::is_none")]
125    pub thumbnail_info: Option<Box<ThumbnailInfo>>,
126
127    /// The source of the thumbnail of the video clip.
128    #[serde(
129        flatten,
130        with = "crate::room::thumbnail_source_serde",
131        skip_serializing_if = "Option::is_none"
132    )]
133    pub thumbnail_source: Option<MediaSource>,
134
135    /// The [BlurHash](https://blurha.sh) for this video.
136    ///
137    /// This uses the unstable prefix in
138    /// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
139    #[cfg(feature = "unstable-msc2448")]
140    #[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
141    pub blurhash: Option<String>,
142}
143
144impl VideoInfo {
145    /// Creates an empty `VideoInfo`.
146    pub fn new() -> Self {
147        Self::default()
148    }
149}
ruma_events/room/message/video.rs

ruma_events/room/message/
video.rs
