-
Notifications
You must be signed in to change notification settings - Fork 229
Add independent webcam recording support across capture, storage, and analysis replay #1159
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
Open
JackWilb
wants to merge
13
commits into
dev
Choose a base branch
from
webcam-recording
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
56cf0ba
Add webcam recording support
JackWilb 13b6bd5
Harden webcam recording lifecycle and replay
JackWilb d79e7ed
Fix webcam recording review findings
JackWilb 8343dd5
Harden recording capture lifecycle
JackWilb 37ba800
Keep synchronized replay callbacks stable
JackWilb b163c08
Refresh replay muting on ownership changes
JackWilb 8729879
Fix scoped recording capture and replay startup
JackWilb d6e39a5
Add replay layout modes for webcam recordings
JackWilb 7b2419b
Add webcam capture to screen recording demo
JackWilb 18845ec
Keep webcam-only replay beside stimulus
JackWilb 8d286c0
Improve webcam replay layouts
JackWilb 8c66e87
Merge origin/dev into webcam recording
JackWilb f0ab321
Keep webcam replay available across layouts and dynamic trials
JackWilb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| This example demonstrates how to capture screen recordings for components where provenance tracking is difficult to implement. In this case, we illustrate the process using simple website components that are recorded directly from the screen. | ||
| This example demonstrates how to capture screen and webcam recordings for components where provenance tracking is difficult to implement. In this case, we illustrate the process using simple website components that are recorded directly from the screen and webcam. | ||
|
|
||
| ## Relevant files: | ||
| * [The Config](https://github.com/revisit-studies/study/blob/main/public/demo-screen-recording/config.json) | ||
| * [bar-chart.html](https://github.com/revisit-studies/study/blob/main/public/demo-screen-recording/assets/bar-chart.html) | ||
|
|
||
| ## Relevant documentation: | ||
| * [Recording Screen and Audio](https://revisit.dev/docs/designing-studies/record-screen/) | ||
| * [Recording Screen, Webcam, and Audio](https://revisit.dev/docs/designing-studies/record-screen/) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "$schema": "https://raw.githubusercontent.com/revisit-studies/study/dev/src/parser/LibraryConfigSchema.json", | ||
| "description": "This library requests webcam and optional microphone permission, then keeps those capture streams active until the end of the study.", | ||
| "components": { | ||
| "webcamRecordingPermission": { | ||
| "description": "Get permission to start webcam recording", | ||
| "type": "react-component", | ||
| "path": "libraries/webcam-recording/assets/WebcamRecording.tsx", | ||
| "nextButtonLocation": "belowStimulus", | ||
| "nextButtonText": "Continue", | ||
| "recordAudio": false, | ||
| "clickToRecord": false, | ||
| "response": [{ | ||
| "hidden": true, | ||
| "type": "reactive", | ||
| "id": "webcamRecordingPermission", | ||
| "prompt": "Webcam recording enabled" | ||
| }] | ||
| } | ||
| }, | ||
| "sequences": {} | ||
| } |
3 changes: 1 addition & 2 deletions
3
public/library-screen-recording/assets/screen-recording-page.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,8 @@ | ||
|
|
||
| # Demo Page | ||
|
|
||
| Any stimulus that follows the `screenRecordingPermission` page can be recorded. | ||
| Any stimulus that follows the `screenRecordingPermission` page can capture both screen and webcam video. | ||
|
|
||
| Explore the webpage in the iframe below, then proceed to the next page. | ||
|
|
||
| <iframe src="https://revisit.dev/" height="600px" style="border: 2px solid #000" > | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
public/library-webcam-recording/assets/webcam-recording-page.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Demo Page | ||
|
|
||
| Any stimulus that follows the `webcamRecordingPermission` page can capture webcam video. | ||
|
|
||
| Proceed to the next page after confirming that your webcam preview is active. |
13 changes: 13 additions & 0 deletions
13
public/library-webcam-recording/assets/webcam-recording.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # WCR: Webcam Recording | ||
|
|
||
| This is a demo of the library `webcam-recording`. | ||
|
|
||
| This library requests webcam and optional microphone permission, then keeps those capture streams active until the end of the study. | ||
|
|
||
| ## Available Components | ||
|
|
||
| - webcamRecordingPermission | ||
|
|
||
| ## Available Sequences | ||
|
|
||
| None |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| { | ||
| "$schema": "https://raw.githubusercontent.com/revisit-studies/study/dev/src/parser/StudyConfigSchema.json", | ||
| "studyMetadata": { | ||
| "title": "WCR: Webcam Recording", | ||
| "version": "1.0.0", | ||
| "authors": [ | ||
| "The reVISit Team" | ||
| ], | ||
| "date": "2026-08-24", | ||
| "description": "Example study using the webcam-recording library.", | ||
| "organizations": [ | ||
| "University of Utah", | ||
| "WPI" | ||
| ] | ||
| }, | ||
| "uiConfig": { | ||
| "contactEmail": "contact@revisit.dev", | ||
| "logoPath": "revisitAssets/revisitLogoSquare.svg", | ||
| "withProgressBar": true, | ||
| "withSidebar": false, | ||
| "recordWebcam": true | ||
| }, | ||
| "importedLibraries": [ | ||
| "webcam-recording" | ||
| ], | ||
| "components": { | ||
| "introduction": { | ||
| "type": "markdown", | ||
| "path": "library-webcam-recording/assets/webcam-recording.md", | ||
| "response": [] | ||
| }, | ||
| "demo-recording": { | ||
| "type": "markdown", | ||
| "path": "library-webcam-recording/assets/webcam-recording-page.md", | ||
| "response": [] | ||
| } | ||
| }, | ||
| "sequence": { | ||
| "order": "fixed", | ||
| "components": [ | ||
| "introduction", | ||
| "$webcam-recording.components.webcamRecordingPermission", | ||
| "demo-recording" | ||
| ] | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.