Skip to content

Commit

Permalink
add admonitions extension and add notes about adding a video config t…
Browse files Browse the repository at this point in the history
…rial, and when not to use trial/session recording
  • Loading branch information
becky-gilbert committed Nov 12, 2024
1 parent 4f4df10 commit 018b920
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@ plugins:

extra:
jsPsych: https://www.jspsych.org/v8/

markdown_extensions:
- admonition
19 changes: 18 additions & 1 deletion packages/record/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,10 @@ Users will need to record themselves accepting the consent document for your
study. This trial will allow the user to read the consent document and record a
video accepting it.

To create the video consent trial.
!!! caution "Don't forget a video config trial!" You MUST have a video config
trial in your experiment timeline before the video consent trial.

To create the video consent trial:

```javascript
const videoConsent = { type: chsRecord.VideoConsentPlugin, ...parameters };
Expand Down Expand Up @@ -335,13 +338,20 @@ that allows you to add video recording to the trial. The trial will start once
the video recording has been set up, and the video recording will finish as soon
as the trial has ended.

!!! important "When to use trial recording" Trial recording should NOT occur
simultaneously with session recording, or with any plugins that already use the
webcam (e.g. video config, video consent).

To use the CHS trial recording extension, you need to:

1. Add it to the experiment settings, which is an optional object passed to
`initjsPsych`.
2. Add it to the `extensions` parameter for any trial(s) that you want to be
recorded.

!!! caution "Don't forget a video config trial!" You MUST have a video config
trial in your experiment timeline before doing any trial recording.

### Parameters

This extension does not accept any parameters.
Expand Down Expand Up @@ -380,10 +390,17 @@ You might prefer to record across multiple trials in a study session. This can
be done by using trials created with the start and stop recording plugins. This
gives a bit of flexibility over which of the study trials are recorded.

!!! important "When to use session recording" Sesssion recording should NOT
occur simultaneously with trial recording, or with any plugins that already use
the webcam (e.g. video config, video consent).

To record a set of trials, add a 'start' trial in your jsPsych experiment
timeline right before you'd like to start recording, and add a 'stop' trial at
the point in your timeline when you'd like to stop recording.

!!! caution "Don't forget a video config trial!" You MUST have a video config
trial in your experiment timeline before doing any session recording.

### Start Recording Plugin

The plugin to start session recording is called `chsRecord.StartRecordPlugin`.
Expand Down

0 comments on commit 018b920

Please sign in to comment.