@agora-build/atem 0.4.98 → 0.4.99
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -70,24 +70,38 @@ atem config convo --config <PATH> # Use a specific config file
|
|
|
70
70
|
```bash
|
|
71
71
|
atem serv convo # Launch ConvoAI test page (HTTPS)
|
|
72
72
|
atem serv convo --config ~/convo.toml # Use custom config
|
|
73
|
-
atem serv convo --background #
|
|
73
|
+
atem serv convo --background # Detached daemon — POSTs /join, registers, exits
|
|
74
|
+
atem serv attach <ID> # Open UI bound to a running convo daemon (talk to live agent)
|
|
75
|
+
atem serv attach 3 # …or by index from `atem serv list`
|
|
74
76
|
atem serv rtc # Launch RTC test page (HTTPS)
|
|
75
77
|
atem serv rtc --channel test --port 8443
|
|
76
78
|
atem serv rtc --background # Run as background daemon
|
|
77
79
|
atem serv diagrams # Host diagrams from SQLite (HTTP)
|
|
78
80
|
atem serv diagrams --port 9000
|
|
79
81
|
atem serv diagrams --background
|
|
80
|
-
atem serv list # List running background servers
|
|
81
|
-
atem serv kill <ID
|
|
82
|
+
atem serv list # List running background servers (#, ID, PID, STATUS)
|
|
83
|
+
atem serv kill <ID|#> # Kill a server (POSTs /leave for convo)
|
|
82
84
|
atem serv killall # Kill all background servers
|
|
85
|
+
|
|
86
|
+
# Fleet test loop — {appid} and {ts} are expanded by atem
|
|
87
|
+
for i in $(seq -f '%04g' 1 10); do
|
|
88
|
+
atem serv convo --background --channel 'atem-convo-{appid}-{ts}-'$i
|
|
89
|
+
sleep 0.5
|
|
90
|
+
done
|
|
83
91
|
```
|
|
84
92
|
|
|
85
|
-
**`serv convo`** — ConvoAI voice agent: live transcription (RTM), preset selection, avatar (Akool, LiveAvatar, Anam), RTC Stats, API History, camera toggle, RTC encryption (key + salt forwarded to the agent).
|
|
93
|
+
**`serv convo`** — ConvoAI voice agent: live transcription (RTM), preset selection, avatar (Akool, LiveAvatar, Anam), RTC Stats, API History, camera toggle, RTC encryption (key + salt forwarded to the agent), HIPAA mode (routes via `/hipaa/api/...`), audio dump.
|
|
94
|
+
|
|
95
|
+
`--background` re-execs as a detached daemon: parent POSTs `/join`, registers in `~/.config/atem/servers/<channel>.json`, exits. The daemon polls Agora's `GET /agents/{id}` every 60s and writes the status (RUNNING/IDLE/STOPPED/…) back into the registry — `atem serv list` reads it without making any network calls. `kill`/`killall` SIGTERM the daemon, which catches the signal and POSTs `/leave` before exiting. Daemon log file (`<channel>.log`) contains the `/join` URL and request body with secrets masked.
|
|
96
|
+
|
|
97
|
+
**`serv attach <id>`** — opens a foreground HTTPS UI bound to a running convo daemon's channel. The page hides Start/Stop because the daemon owns the agent; you Join to talk to the live agent. Encryption / HIPAA / geofence read from the same `convo.toml` so the local SDK matches what the daemon used.
|
|
86
98
|
|
|
87
99
|
**`serv rtc`** — RTC test page: join/leave, publish/subscribe audio+video, token generation, RTM messaging, RTC encryption (8 modes; gcm2 modes auto-generate a copyable salt).
|
|
88
100
|
|
|
89
101
|
**`serv diagrams`** — SQLite-backed HTTP server for hosting AI-generated HTML diagrams.
|
|
90
102
|
|
|
103
|
+
**Channel placeholders** — `--channel` accepts `{appid}` (first 12 chars of the active app id) and `{ts}` (unix epoch seconds at startup). Useful in for-loops to match the auto-gen channel format.
|
|
104
|
+
|
|
91
105
|
### AI Agents (WIP)
|
|
92
106
|
|
|
93
107
|
```bash
|