Skip to content

Record audio and UI for your VS Code session and share it easily with others for playback

Notifications You must be signed in to change notification settings

kamranayub/vs-code-presenter

Repository files navigation

presenter README

See my series of tweets.

Highly experimental. Probably crazy.

Features

  • Capture audio from a recording device
  • Captures UI events including keystrokes
  • Exports to a file that can be shared
  • Plays back recordings with "virtual" workspace

Prior Art

https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour

Similar to CodeTour, but designed for presentations/recordings. If you could replace the commenting of CodeTours with audio clips, and it also supported recording edits to the file, it would be a close match.

TODO

Gotta figure out:

  • How to playback virtually without requiring exact machine/workspace configuration?
  • Does it just snapshot the state of VS Code? If so how does it restore?
  • What about other parts of the UI (terminal, etc.)?
  • What about different VS code versions over time? Does it matter (i.e. this thing just TAKES OVER and the UI is what it was when it was recorded)?

Ideas:

  • Similar "mode" to debugging where status bar and UI changes to "record" mode
  • In playback mode, I think the only way for this to work is to take control over the entire IDE
  • Users could edit in playback mode, but it probably wouldn't do anything--without actual physical files/configuration, nothing would work
  • Could it allow tying into Git commits? Would that be a way to distribute the workspace? It would have to have preparation steps or automation (npm, etc.).
  • If VS code exposes eventing model and actions, that could be a standard API surface to record/playback as long as underlying workspace and configuration was the same. Or if something like Redux was used to allow for time traveling over state.
  • THIS IS CRAZY.

Requirements

Extension Settings

Known Issues

  • It doesn't work yet

Release Notes

About

Record audio and UI for your VS Code session and share it easily with others for playback

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published