diff --git a/README.md b/README.md index d5a9b3b..c5a3ac3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,26 @@ Cross-platform voice and video messaging plugin for Mattermost with full support for web, desktop, iOS and Android. +## Recording → playback flow + +```mermaid +flowchart LR + A[User taps mic / cam
or types /voice or /video] --> B[Permission prompt
navigator.mediaDevices] + B -->|granted| C[MediaRecorder
WebM Opus / VP9] + C --> D{Pause / resume
during recording} + D --> E[Encode to Blob
≤ 50 MB audio
≤ 100 MB video] + E --> F[POST /api/v4/files
multipart upload] + F --> G[Mattermost file store] + G --> H[Post message
with file_ids] + H --> I[Recipient renders
waveform / circle preview
+ 1× / 1.25× / 1.5× / 2× speed] +``` + +Recording happens entirely in the browser — the plugin never proxies +the audio. Only the final encoded Blob crosses the wire, via the +standard Mattermost file-upload API. iOS Safari 14.3+ and Android +Chrome both expose `MediaRecorder`, so the same code path works on +mobile, desktop and web. + ## Features ### Voice Messages