admin/momentry_core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: regenerate HTML/WASM docs with video vs clip comparison + timestamps

Browse Source
This commit is contained in:
Accusys
2026-05-19 12:51:10 +08:00
parent 5b2f9b35bf
commit c9bcdcb56a
28 changed files with 188 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs_v1.0/doc_wasm/modules/01_auth.md
View File

@@ -278,3 +278,6 @@ Protected Request
- `POST /api/v1/resource/tmdb/check` — test authentication + TMDb API connectivity
- `GET /health/detailed` — view auth status (integrations section)
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/02_health.md
View File

@@ -185,3 +185,6 @@ curl -s "$API/health/consistency" -H "X-API-Key: $KEY" | jq '.checks[] | {check,
| Method | Endpoint | Auth | Description |
|--------|----------|------|-------------|
| GET | `/api/v1/stats/sftpgo` | No | SFTPGo service status |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/03_register.md
View File

@@ -183,3 +183,6 @@ curl -s "$API/api/v1/files/scan?sort_by=status&page_size=5" -H "X-API-Key: $KEY"
| **Sort order** | Default (`sort_by=name`): registered files first, then alphabetically. `sort_by=status`: alphabetical by status string. |
| **Pagination** | `page_size` and `limit` are aliases. Default: show all results. |
| **Processing order** | `pattern` regex filter → `sort_by`/`sort_order` → `page`/`page_size` slice. |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/04_lookup.md
View File

@@ -136,3 +136,6 @@ curl -s -X POST "$API/api/v1/unregister" \
| `400` | Neither `file_uuid` nor `file_path`+`pattern` provided |
| `404` | File UUID not found |
| `401` | Missing or invalid API key |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/05_process.md
View File

@@ -234,3 +234,6 @@ curl -s "$API/api/v1/jobs" -H "X-API-Key: $KEY" | jq '{count, jobs: [.jobs[] | {
| `count` | integer | Total job count |
| `page` | integer | Current page number |
| `page_size` | integer | Jobs per page |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/06_search.md
View File

@@ -143,3 +143,6 @@ Search text chunks spoken by a specific identity.
| **Endpoint** | `POST /api/v1/embeddings` on port 11436 |
| **Dimension** | 768 |
| **Storage** | pgvector (`chunk.embedding` column) |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/07_identity.md
View File

@@ -331,3 +331,6 @@ curl -s "$API/api/v1/identity/$IDENTITY_UUID/profile-image" \
| `content-type` | `image/jpeg` or `image/png` |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/08_identity_agent.md
View File

@@ -63,3 +63,6 @@ curl -s -X POST "$API/api/v1/agents/identity/match-from-trace" \
-H "Content-Type: application/json" \
-d '{"file_uuid": "'"$FILE_UUID"'", "trace_id": 10}'
```
---
*Updated: 2026-05-19 12:49:24*

29
docs_v1.0/doc_wasm/modules/08_media.md
View File

@@ -135,6 +135,32 @@ curl -s "$API/api/v1/file/bd80fec92b0b6963d177a2c55bf713e2/clip?start_time=30&en
| **Codec** | H.264 + AAC |
| **Cache** | `Cache-Control: public, max-age=86400` (24h) |
### Video vs Clip: Quality & Format Comparison
Both endpoints support time range extraction, but serve different use cases:
| Feature | `/video` | `/clip` |
|---------|----------|---------|
| **No params** | Streams full file (Range seek) | Returns 400 (params required) |
| **HTTP Range** | ✅ Supported | ❌ Not supported |
| **Encoding** | `-c copy` (zero encoding) | `-c:v libx264 -c:a aac` (re-encode) |
| **Quality** | Original (bit-exact, zero loss) | Compressed (default CRF ≈ 23) |
| **Format** | `video/mp4` | `video/mp2t` (MPEG-TS) |
| **Speed** | Fast (no computation) | Slower (encoding required) |
| **Frame control** | Time-based (`dur = (ef-sf)/fps`) | Precise (`-vframes`) |
| **Debug mode** | ❌ | ✅ `mode=debug` overlay |
| **Cache** | ❌ | ✅ `max-age=86400` |
#### Usage Recommendation
| Scenario | Use |
|----------|-----|
| Full video streaming / player seek | `/video` |
| Quick preview clip (zero quality loss) | `/video?start_frame=...&end_frame=...` |
| Debug frame verification / text overlay | `/clip?mode=debug` |
| Precise frame count control | `/clip` |
| CDN cacheable clip | `/clip` |
---
| Detail | Value |
@@ -144,3 +170,6 @@ curl -s "$API/api/v1/file/bd80fec92b0b6963d177a2c55bf713e2/clip?start_time=30&en
| **Output** | Single JPEG via pipe (`image2pipe`, `mjpeg` codec) |
| **Cache** | `Cache-Control: public, max-age=86400` (24h) |
| **Frame number** | Zero-based (`frame=0` = first frame of video) |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/09_tmdb.md
View File

@@ -107,3 +107,6 @@ curl -s -X POST "$API/api/v1/resource/tmdb/check" \
"api_latency_ms": 120
}
```
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/10_pipeline.md
View File

@@ -120,3 +120,6 @@ The following routes are defined in source code but are **NOT** currently mounte
| `/api/v1/search/persons` | `universal_search.rs` (not mounted) |
| `/api/v1/who` | `who.rs` |
| `/api/v1/who/candidates` | `who.rs` |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/11_error_codes.md
View File

@@ -55,3 +55,6 @@ All API errors follow this JSON structure:
| `E303_TMDB_CACHE_NOT_FOUND` | 200 | No local TMDb cache; run prefetch first |
| `E304_TMDB_PROBE_FAILED` | 500 | TMDb probe execution failed |
| `E305_TMDB_MOVIE_NOT_FOUND` | 404 | No matching TMDb movie found from filename |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/12_agent.md
View File

@@ -116,3 +116,6 @@ Get status of the 5W1H agent pipeline for a file.
| **Dimension** | 768 |
| **Used by** | `parent_chunk_5w1h.py --embed`, story, 5W1H, search |
---
*Updated: 2026-05-19 12:49:24*

3
docs_v1.0/doc_wasm/modules/13_config.md
View File

@@ -85,3 +85,6 @@ curl -s -X POST "$API/api/v1/config/watcher-auto-register" \
-H "X-API-Key: $KEY" \
-d '{"enabled": true}'
```
---
*Updated: 2026-05-19 12:49:24*