Skip to content

Commit 6ec0045

Browse files
committed
Update SimDeck agent instructions
1 parent 510597b commit 6ec0045

3 files changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ codec/profile when it starts. Studio defaults to the `smooth` stream quality
8383
profile (`1170` longest edge, dynamic up to `60` fps). Use
8484
`--stream-quality quality|balanced|smooth|economy|ci-software` to override it,
8585
or pass `--video-codec hardware` when a dedicated hardware encoder is preferable.
86+
The remote viewer renders live video with the browser's native video element;
87+
the canvas is only used for input geometry.
8688

8789
CLI commands automatically use the same warm daemon:
8890

docs/guide/video.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ A few practical guidelines:
8080
- **Start on the default for local preview.** `auto` lets VideoToolbox choose without requiring the shared hardware encoder.
8181
- **Switch to `software` when the hardware encoder stalls or is unavailable.** The encoder scales the longest edge to 1600 pixels, can climb toward 60 fps, and backs off dynamically under encode latency.
8282
- **Studio providers default to software H.264 plus `--stream-quality smooth`.** This profile uses a 1170-pixel longest edge, allows up to 60 fps, raises the bitrate budget to reduce compression artifacts, and lets multiple provider sessions share CPU cores without depending on one hardware encoder.
83+
- **The remote browser renders the live stream as a native `<video>` element.** The canvas remains for input geometry, but it is not in the live per-frame render path and does not preserve stale frames during reconnects.
8384
- **Use `--stream-quality ci-software` for denser virtualized CI Macs.** This profile uses software H.264 at a 960-pixel longest edge, targets 24 fps, lowers bitrate pressure, and favors fresh frames over full-resolution sharpness.
8485
- **Use `simdeck studio expose --video-codec hardware` only when a dedicated hardware encoder is preferable.** The normal Studio default stays on software H.264 so future multi-simulator provider hosts can scale across CPU cores.
8586
- **Use `software --low-latency` only when you need the older extra-conservative software profile.** It caps at 15 fps, uses a single pending frame, reduces the longest edge to 1170 pixels, and backs off before software encode latency turns into seconds of stream delay.

server/src/main.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -690,8 +690,7 @@ fn studio_stream_quality_profile(
690690
requested
691691
.map(|profile| profile.as_profile_id().to_owned())
692692
.or_else(|| {
693-
(video_codec == VideoCodecMode::Software && !low_latency)
694-
.then_some("smooth".to_owned())
693+
(video_codec == VideoCodecMode::Software && !low_latency).then_some("smooth".to_owned())
695694
})
696695
}
697696

0 commit comments

Comments
 (0)