Mercurial > prosody-modules

comparison mod_muc_media_metadata/README.markdown @ 3683:1432020c33c7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_media_metadata: Fix README filename
author Matthew Wild <mwild1@gmail.com>
date Sun, 29 Sep 2019 16:49:42 +0100
parents mod_muc_media_metadata/README.md@47e1c94fb6fb
children 0f3cb1247682
comparison
equal deleted inserted replaced
3682:47e1c94fb6fb 3683:1432020c33c7
1 # Introduction
2
3 This module adds additional metadata to media shared in a MUC. This can help clients
4 make decisions and provide better UI and enhanced privacy, by knowing things like file
5 size without needing to make external network requests.
6
7 # Configuring
8
9 ## Enabling
10
11 ``` {.lua}
12 Component "rooms.example.net" "muc"
13 modules_enabled = {
14 "muc_hide_media";
15 }
16 ```
17
18 ## Settings
19
20 There are no configuration options for this module.
21
22 # Developers
23
24 Example stanza:
25
26 ```
27 <message from="test@rooms.example.com/matthew" id="9f45a784-5e5b-4db5-a9b3-8ea1d7c1162d" type="groupchat">
28 <body>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</body>
29 <x xmlns="jabber:x:oob">
30 <url>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</url>
31 <metadata xmlns="https://prosody.im/protocol/media-metadata#0">
32 <bytes>15690</bytes>
33 <type>image/png</type>
34 <blurhash>LEHV6nWB2yk8pyo0adR*.7kCMdnj</blurhash>
35 </metadata>
36 </x>
37 </message>
38 ```