Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API for screenshots #70

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Add API for screenshots #70

wants to merge 13 commits into from

Conversation

NateLanza
Copy link
Contributor

This adds an API for taking screenshots of the current tab manually and when certain actions are trracked.

The ScreenshotStream interface defines an API for capturing screenshots. Screenshots are taken via the MediaDevices API, specifically the getDisplayMedia() function. After starting a stream of frames from the browser, individual shots can be saved at any point, either manually or when triggering actions fire.

The Registry API has been updated to add 2 fields: triggersScreenshot, which defines whether an action should fire a screenshot, and transitionTime, which defines how long it takes for an action to be reflected in the visualization and therefore the delay before screenshotting.

The Trrack object has been updated with a new field, screenshots, an instance of ScreenshotStream. This exposes methods for starting capture (necessary to obtain a stream of frames from the browser), which asks the user for permission to share the current tab. There are also methods to capture a screenshot immediately, capture after a delay, stop the MediaStream that provides frames from the screenshare, and get saved screenshots. The current implementation of ScreenshotStream saves all captured screenshots to an array. The Trrack object does not take screenshots due to actions with triggersScreenshot = true until the ScreenshotStream has been started.

Nate Lanza added 12 commits April 28, 2024 15:32
…ith one bug remaining

Native screenshots are working, but the catpureNextRepaint() function doesn't yet capture the next
repaint; it takes a screenshot before the next repaint
…to use functional approach

ScreenshotStream now uses the functional approach that the rest of Trrack uses instead of OO/class
based
Adds an API to the event registry allowing users to define whether actions should trigger
screenshots and the associated delay. Adds an API to the trrack object for screenshots.
…eenshots available

Also updates react-trrack-example to match
@NateLanza NateLanza added the enhancement New feature or request label May 21, 2024
@NateLanza NateLanza self-assigned this May 21, 2024
Copy link

vercel bot commented May 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
trrackjs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2024 9:50pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant