API Docs for: 0.5.1
Show:

ExpVideoPreview Class

A frame that displays a series of videos to preview, without collecting data as a live experiment. User can go through these at their own pace and video controls are shown. Webcam video is recorded starting once the user presses a button to actually display the videos, so that researchers can check that the participant (infant/child) did not see the videos ahead of time.

"frames": {
   "my-sample-frame": {
       "id": "video-preview",
       "kind": "exp-video-preview",
       "text": "Here are the videos your child will see in this study. You can watch them ahead of time--please just don't show your child yet!",
       "prompt": "My child can NOT see the screen. Start the preview!",
       "videos": [
          {
            "caption": "User-facing text that appears below the video",
            "sources": [
              {
                "type": "video/webm",
                "src": "https://url.com/example_intro.webm"
              },
              {
                "type": "video/mp4",
                "src": "https://url.com/example_intro.webm"
              }
            ]
          }
        ]
   }

Item Index

Properties

Events

Methods

serializeContent

(
  • videoID
  • eventTimings
)
Object

Parameters captured and sent to the server

Parameters:

  • videoID String

    The ID of any video recorded during this frame

  • eventTimings Object

Returns:

Object:

The payload sent to the server

Properties

prompt

String

Text on the button prompt asking the user to continue to the videos

text

String

Informational text to display to the user before videos are shown, along with button to continue

videos

Array

A series of preview videos to display within a single frame, defined as an array of objects.

Sub-properties:

  • caption String

    Some text to appear under this video

  • sources Object[]

    Array of {src: 'url', type: 'MIMEtype'} objects.

  • imgSrc String

    URL of image to display (optional; each preview video should designate either sources or imgSrc)

Events

nextFrame

Move to next frame