StreamOverlayBuilder.tsx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. /**
  2. * Streaming-overlay URL builder (#1422).
  3. *
  4. * The overlay at /overlay/{printerId} has been configurable by query string
  5. * since #2613, but only for people who found the parameters in the wiki. The
  6. * issue asked for the field set to be selectable "through the web UI"; this is
  7. * that surface. It composes a URL, it does not persist anything — the URL *is*
  8. * the configuration, which keeps a scene in OBS reproducible by copy-paste and
  9. * means two displays can show different fields off one token.
  10. */
  11. import { useEffect, useMemo, useState } from 'react';
  12. import { useTranslation } from 'react-i18next';
  13. import { Copy, ExternalLink, Eye, EyeOff } from 'lucide-react';
  14. import { api, type Printer } from '../api/client';
  15. import { useToast } from '../contexts/ToastContext';
  16. type OverlaySize = 'small' | 'medium' | 'large';
  17. // Order matters: it is the order the fields appear in the overlay, so the
  18. // checkbox list reads as a preview of the result.
  19. const FIELDS = [
  20. { key: 'printer', labelKey: 'streamOverlay.builder.fieldPrinter', fallback: 'Printer name' },
  21. { key: 'filename', labelKey: 'streamOverlay.builder.fieldFilename', fallback: 'File name' },
  22. { key: 'status', labelKey: 'streamOverlay.builder.fieldStatus', fallback: 'Status' },
  23. { key: 'progress', labelKey: 'streamOverlay.builder.fieldProgress', fallback: 'Progress bar' },
  24. { key: 'layers', labelKey: 'streamOverlay.builder.fieldLayers', fallback: 'Layer count' },
  25. { key: 'eta', labelKey: 'streamOverlay.builder.fieldEta', fallback: 'Time remaining and ETA' },
  26. { key: 'nozzle', labelKey: 'printers.heaterHistory.nozzle', fallback: 'Nozzle' },
  27. { key: 'bed', labelKey: 'printers.heaterHistory.bed', fallback: 'Bed' },
  28. { key: 'chamber', labelKey: 'printers.heaterHistory.chamber', fallback: 'Chamber' },
  29. ] as const;
  30. // Matches parseConfig() in StreamOverlayPage: the fields an overlay shows when
  31. // the URL carries no ?show= at all.
  32. const DEFAULT_FIELDS = ['progress', 'layers', 'eta', 'filename', 'status'];
  33. const DEFAULT_FPS = 15;
  34. export function StreamOverlayBuilder() {
  35. const { t } = useTranslation();
  36. const { showToast } = useToast();
  37. const [printers, setPrinters] = useState<Printer[]>([]);
  38. const [printerId, setPrinterId] = useState<number | null>(null);
  39. const [fields, setFields] = useState<string[]>(DEFAULT_FIELDS);
  40. const [size, setSize] = useState<OverlaySize>('medium');
  41. const [fps, setFps] = useState(DEFAULT_FPS);
  42. const [showCamera, setShowCamera] = useState(true);
  43. const [token, setToken] = useState('');
  44. const [preview, setPreview] = useState(false);
  45. useEffect(() => {
  46. let cancelled = false;
  47. void (async () => {
  48. try {
  49. const list = await api.getPrinters();
  50. if (cancelled) return;
  51. setPrinters(list);
  52. if (list.length > 0) setPrinterId(list[0].id);
  53. } catch {
  54. // A failed printer list only costs the picker its options — the builder
  55. // still works if the user types a printer number into the URL by hand,
  56. // so this is not worth a toast on a settings page they may just be
  57. // scrolling past.
  58. }
  59. })();
  60. return () => {
  61. cancelled = true;
  62. };
  63. }, []);
  64. const url = useMemo(() => {
  65. const id = printerId ?? 1;
  66. const params = new URLSearchParams();
  67. // Emit ?show= in the canonical field order rather than click order, so the
  68. // same selection always produces the same URL.
  69. const selected = FIELDS.filter((f) => fields.includes(f.key)).map((f) => f.key);
  70. params.set('show', selected.join(','));
  71. if (size !== 'medium') params.set('size', size);
  72. if (fps !== DEFAULT_FPS) params.set('fps', String(fps));
  73. if (!showCamera) params.set('camera', 'false');
  74. if (token.trim()) params.set('token', token.trim());
  75. return `${window.location.origin}/overlay/${id}?${params.toString()}`;
  76. }, [printerId, fields, size, fps, showCamera, token]);
  77. const toggleField = (key: string) => {
  78. setFields((prev) => (prev.includes(key) ? prev.filter((f) => f !== key) : [...prev, key]));
  79. };
  80. const copyUrl = async () => {
  81. try {
  82. // Same fallback as the token dialog: the clipboard API needs a secure
  83. // context, and plenty of Bambuddy installs are plain HTTP on a LAN.
  84. if (navigator.clipboard && window.isSecureContext) {
  85. await navigator.clipboard.writeText(url);
  86. } else {
  87. const ta = document.createElement('textarea');
  88. ta.value = url;
  89. ta.style.position = 'fixed';
  90. ta.style.opacity = '0';
  91. document.body.appendChild(ta);
  92. try {
  93. ta.select();
  94. document.execCommand('copy');
  95. } finally {
  96. document.body.removeChild(ta);
  97. }
  98. }
  99. showToast(t('cameraTokens.toast.copied', 'Copied to clipboard'));
  100. } catch {
  101. showToast(t('cameraTokens.toast.copyFailed', 'Copy failed — select and copy manually'), 'error');
  102. }
  103. };
  104. return (
  105. <div>
  106. <p className="text-sm text-bambu-gray mb-4">
  107. {t(
  108. 'streamOverlay.builder.description',
  109. 'Build the URL for a streaming overlay — a full-screen camera view with live print data drawn over it, for OBS, a wall display, or any browser source. Pick the fields you want and copy the URL.',
  110. )}
  111. </p>
  112. <div className="grid gap-4 md:grid-cols-2">
  113. <div>
  114. <label
  115. htmlFor="overlay-builder-printer"
  116. className="block text-sm font-medium text-white mb-1"
  117. >
  118. {t('streamOverlay.builder.printer', 'Printer')}
  119. </label>
  120. <select
  121. id="overlay-builder-printer"
  122. value={printerId ?? ''}
  123. onChange={(e) => setPrinterId(Number(e.target.value))}
  124. className="w-full px-3 py-2 bg-bambu-dark rounded-md text-white border border-bambu-dark-tertiary focus:border-bambu-green focus:outline-none"
  125. >
  126. {printers.length === 0 && <option value="">{t('common.loading', 'Loading…')}</option>}
  127. {printers.map((p) => (
  128. <option key={p.id} value={p.id}>
  129. {p.name}
  130. </option>
  131. ))}
  132. </select>
  133. </div>
  134. <div>
  135. <label htmlFor="overlay-builder-size" className="block text-sm font-medium text-white mb-1">
  136. {t('streamOverlay.builder.size', 'Text size')}
  137. </label>
  138. <select
  139. id="overlay-builder-size"
  140. value={size}
  141. onChange={(e) => setSize(e.target.value as OverlaySize)}
  142. className="w-full px-3 py-2 bg-bambu-dark rounded-md text-white border border-bambu-dark-tertiary focus:border-bambu-green focus:outline-none"
  143. >
  144. <option value="small">{t('streamOverlay.builder.sizeSmall', 'Small')}</option>
  145. <option value="medium">{t('streamOverlay.builder.sizeMedium', 'Medium')}</option>
  146. <option value="large">{t('streamOverlay.builder.sizeLarge', 'Large')}</option>
  147. </select>
  148. </div>
  149. <div>
  150. <label htmlFor="overlay-builder-fps" className="block text-sm font-medium text-white mb-1">
  151. {t('streamOverlay.builder.fps', 'Frame rate')}
  152. </label>
  153. <input
  154. id="overlay-builder-fps"
  155. type="number"
  156. min={1}
  157. max={30}
  158. value={fps}
  159. onChange={(e) => setFps(Math.min(Math.max(Number(e.target.value) || 1, 1), 30))}
  160. className="w-full px-3 py-2 bg-bambu-dark rounded-md text-white border border-bambu-dark-tertiary focus:border-bambu-green focus:outline-none"
  161. />
  162. <p className="text-xs text-bambu-gray mt-1">
  163. {t(
  164. 'streamOverlay.builder.fpsHint',
  165. 'A1 and P1 cameras top out around 5 fps whatever you ask for.',
  166. )}
  167. </p>
  168. </div>
  169. <div>
  170. <label htmlFor="overlay-builder-token" className="block text-sm font-medium text-white mb-1">
  171. {t('streamOverlay.builder.token', 'Streaming Overlay token (optional)')}
  172. </label>
  173. <input
  174. id="overlay-builder-token"
  175. type="text"
  176. value={token}
  177. onChange={(e) => setToken(e.target.value)}
  178. placeholder="bblt_…"
  179. className="w-full px-3 py-2 bg-bambu-dark rounded-md text-white border border-bambu-dark-tertiary focus:border-bambu-green focus:outline-none font-mono text-xs"
  180. />
  181. <p className="text-xs text-bambu-gray mt-1">
  182. {t(
  183. 'streamOverlay.builder.tokenHint',
  184. 'Only needed when login is enabled: OBS has no session of its own. Create one above with the Streaming Overlay scope.',
  185. )}
  186. </p>
  187. </div>
  188. </div>
  189. <fieldset className="mt-4">
  190. <legend className="text-sm font-medium text-white mb-2">
  191. {t('streamOverlay.builder.fields', 'Fields to show')}
  192. </legend>
  193. <div className="grid gap-2 sm:grid-cols-2 md:grid-cols-3">
  194. {FIELDS.map((field) => (
  195. <label key={field.key} className="flex items-center gap-2 text-sm text-bambu-gray">
  196. <input
  197. type="checkbox"
  198. checked={fields.includes(field.key)}
  199. onChange={() => toggleField(field.key)}
  200. className="accent-bambu-green"
  201. />
  202. {t(field.labelKey, field.fallback)}
  203. </label>
  204. ))}
  205. <label className="flex items-center gap-2 text-sm text-bambu-gray">
  206. <input
  207. type="checkbox"
  208. checked={showCamera}
  209. onChange={(e) => setShowCamera(e.target.checked)}
  210. className="accent-bambu-green"
  211. />
  212. {t('streamOverlay.builder.fieldCamera', 'Camera feed')}
  213. </label>
  214. </div>
  215. <p className="text-xs text-bambu-gray mt-2">
  216. {t(
  217. 'streamOverlay.builder.chamberHint',
  218. 'Chamber temperature only appears on models with a real chamber sensor — P1 and A1 printers report a meaningless value, so it is left out there.',
  219. )}
  220. </p>
  221. </fieldset>
  222. <div className="mt-4">
  223. <p className="text-sm font-medium text-white mb-1">
  224. {t('streamOverlay.builder.urlTitle', 'Overlay URL')}
  225. </p>
  226. <div className="flex items-center gap-2">
  227. <code className="flex-1 px-3 py-2 bg-bambu-dark rounded-md text-bambu-green text-xs break-all font-mono select-all">
  228. {url}
  229. </code>
  230. <button
  231. type="button"
  232. onClick={() => void copyUrl()}
  233. className="flex items-center gap-2 px-3 py-2 bg-bambu-green text-white rounded-md hover:bg-bambu-green/90"
  234. >
  235. <Copy className="w-4 h-4" />
  236. {t('cameraTokens.created.copy', 'Copy')}
  237. </button>
  238. <a
  239. href={url}
  240. target="_blank"
  241. rel="noopener noreferrer"
  242. className="flex items-center gap-2 px-3 py-2 bg-bambu-dark-tertiary text-white rounded-md hover:bg-bambu-dark-tertiary/80"
  243. >
  244. <ExternalLink className="w-4 h-4" />
  245. {t('streamOverlay.builder.open', 'Open')}
  246. </a>
  247. </div>
  248. {token.trim() && (
  249. <p className="text-xs text-bambu-gray mt-2">
  250. {t(
  251. 'streamOverlay.builder.tokenWarning',
  252. 'This URL contains a token — anyone who can read it can watch the stream and see the file name. Revoke the token to cut it off.',
  253. )}
  254. </p>
  255. )}
  256. </div>
  257. {/* The preview opens a real camera stream, so it stays off until asked
  258. for. Leaving one running behind a settings tab would hold a subscriber
  259. on the printer's single camera connection for as long as the tab is
  260. open. */}
  261. <div className="mt-4">
  262. <button
  263. type="button"
  264. onClick={() => setPreview((p) => !p)}
  265. className="flex items-center gap-2 px-3 py-2 bg-bambu-dark-tertiary text-white rounded-md hover:bg-bambu-dark-tertiary/80 text-sm"
  266. >
  267. {preview ? <EyeOff className="w-4 h-4" /> : <Eye className="w-4 h-4" />}
  268. {preview
  269. ? t('streamOverlay.builder.hidePreview', 'Hide preview')
  270. : t('streamOverlay.builder.showPreview', 'Show preview')}
  271. </button>
  272. {preview && (
  273. <iframe
  274. key={url}
  275. src={url}
  276. title={t('streamOverlay.builder.previewTitle', 'Overlay preview')}
  277. className="mt-3 w-full aspect-video rounded-md border border-bambu-dark-tertiary bg-black"
  278. />
  279. )}
  280. </div>
  281. </div>
  282. );
  283. }