Mercurial > prosody-modules
view mod_muc_media_metadata/README.markdown @ 4974:807007913f67
mod_log_json: Prefer native Lua table.pack over Prosody util.table one
Prosody is removing support for Lua 5.1, which was the reason for
util.table.pack to exist in the first place, since Lua 5.2+ provides
table.pack. In prosody rev 5eaf77114fdb everything was switched over to
use table.pack, opening the door for removing util.table.pack at some
point. This change here is to prepare for that future eventuality.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 11 Jul 2022 20:08:41 +0200 |
parents | 0e1e775bdea0 |
children |
line wrap: on
line source
--- labels: - 'Stage-Alpha' summary: 'Experimental module to add metadata to media in MUCs' ... # Introduction This module adds additional metadata to media shared in a MUC. This can help clients make decisions and provide better UI and enhanced privacy, by knowing things like file size without needing to make external network requests. ::: {.alert .alert-danger} **NOTE:** This is an experimental module. It is not supported by any clients, and therefore is mainly of interest to client developers who wish to explore the idea. ::: # Configuring ## Enabling ``` {.lua} Component "rooms.example.net" "muc" modules_enabled = { "muc_media_metadata"; } ``` ## Settings There are no configuration options for this module. # Developers ## Example stanzas A normal message in a chatroom containing an image: ``` <message from="test@rooms.example.com/matthew" id="9f45a784-5e5b-4db5-a9b3-8ea1d7c1162d" type="groupchat"> <body>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</body> <x xmlns="jabber:x:oob"> <url>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</url> </x> </message> ``` The same stanza with this module loaded now contains additional metadata added by the server: ``` <message from="test@rooms.example.com/matthew" id="9f45a784-5e5b-4db5-a9b3-8ea1d7c1162d" type="groupchat"> <body>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</body> <x xmlns="jabber:x:oob"> <url>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</url> <metadata xmlns="xmpp:prosody.im/protocol/media-metadata#0"> <bytes>15690</bytes> <type>image/png</type> <blurhash>LEHV6nWB2yk8pyo0adR*.7kCMdnj</blurhash> </metadata> </x> </message> ```