Show:

Exp-lookit-dialogue-page Class

This class is deprecated.

This frame is deprecated and will not be included in release 2.x. For new studies, use the frame Exp-lookit-images-audio instead.

Frame to implement a storybook page with dialogue spoken by characters. First, characters appear and any main narration audio is played. Next, the user can click on the characters to play additional audio associated with each character image, or (for a choice trial) the user clicks one of the images to select it as an answer. Once main narration audio has been played and either a selection has been made (for a choice trial, isChoiceFrame: true) or all required character audio has been played (for a non-choice trial), the user can proceed by pressing 'next'. (A trial with only main narration audio can also simply auto-proceed when audio is finished.)

Recording is optional. If webcam recording is conducted (doRecording: true) then audio does not start until recording does, to ensure the entire trial is recorded.

The character images are specified in 'images', including an image source, positioning on the screen, any animation at the start of the trial, any associated audio, and whether that audio is required.

This frame is displayed fullscreen; if the frame before it is not, that frame needs to include a manual "next" button so that there's a user interaction event to trigger fullscreen mode. (Browsers don't allow us to switch to FS without a user event.)

The examples below show a few expected uses of this frame. In phase-2, two characters are shown; the protagonist is already present, and speaker1 flies in from the left. Speaker1 has associated audio (dialogue). After the narrative audio, the user can click on speaker1 to play the audio, and will then be able to proceed.

phase-5 is a choice trial, where the user has to click on one of the two images before proceeding.

"frames": {
       "phase-2": {
           "kind": "exp-lookit-dialogue-page",
           "baseDir": "https://s3.amazonaws.com/lookitcontents/politeness/",
           "audioTypes": ["mp3", "ogg"],
           "backgroundImage": "order1_test1_background.png",
           "doRecording": false,
           "autoProceed": false,
           "parentTextBlock": {
               "title": "Parents!",
               "text": "some instructions",
               "emph": true,
               "css": {
                   "color": "red",
                   "font-size": "12px"
               }
           },
           "images": [
               {
                   "id": "protagonist",
                   "src": "order1_test1_listener1.png",
                   "left": "40",
                   "bottom": "2",
                   "height": "60"
               },
               {
                   "id": "speaker1",
                   "text": "Click to hear what he said!",
                   "src": "order1_test1_speaker1.png",
                   "left": "20",
                   "bottom": "2",
                   "height": "60",
                   "animate": "flyleft",
                   "requireAudio": true,
                   "imageAudio": "polcon_example_2_2speaker1polite"
               }
           ],
           "audioSources": [
               {
                   "audioId": "firstAudio",
                   "sources": "polcon_example_2_1intro"
               }
           ]
       },
       "phase-5": {
           "kind": "exp-lookit-dialogue-page",
           "baseDir": "https://s3.amazonaws.com/lookitcontents/politeness/",
           "audioTypes": ["mp3", "ogg"],
           "backgroundImage": "order1_test1_background.png",
           "doRecording": false,
           "autoProceed": false,
           "isChoiceFrame": true,
           "parentTextBlock": {
               "title": "Parents:",
               "text": "click on the character your child selects.",
               "emph": true
           },
           "images": [
               {
                   "id": "speaker1",
                   "src": "order1_test1_speaker1.png",
                   "left": "20",
                   "bottom": "2",
                   "height": "60"
               },
               {
                   "id": "speaker2",
                   "src": "order1_test1_speaker2.png",
                   "left": "60",
                   "bottom": "2",
                   "height": "60"
               }
           ],
           "audioSources": [
               {
                   "audioId": "firstAudio",
                   "sources": "polcon_example_5q1"
               }
           ]
       }
}

Methods

destroyRecorder

()
Destroy recorder and stop accessing webcam

destroySessionRecorder

()
Destroy recorder and stop accessing webcam

exitFullscreen

()

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:139

Exit fullscreen mode

hideRecorder

()
Hide the recorder from display. Useful if you would like to keep recording without extra UI elements to distract the user.

makeTimeEvent

(
  • eventName
  • [extra]
)
Object

Create the time event payload for a particular frame / event. This can be overridden to add fields to every event sent by a particular frame

Parameters:

  • eventName String
  • [extra] Object optional

    An object with additional properties to be sent to the server

Returns:

Object:

Event type, time, and any additional metadata provided

onRecordingStarted

()
Function called when frame recording is started automatically. Override to do frame-specific actions at this point (e.g., beginning a test trial).

onSessionRecordingStarted

()
Function called when session recording is started automatically. Override to do frame-specific actions at this point (e.g., beginning a test trial).

serializeContent

(
  • eventTimings
)
Object

Each frame that extends ExpFrameBase will send at least an array eventTimings, a frame type, and any generateProperties back to the server upon completion. Individual frames may define additional properties that are sent.

Parameters:

Returns:

setupRecorder

(
  • element
)
Promise

Inherited from Session-record but overwritten in app/mixins/video-record.js:294

Set up a video recorder instance

Parameters:

  • element Node
    A DOM node representing where to mount the recorder

Returns:

Promise: A promise representing the result of installing the recorder

showFullscreen

()

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:112

Make a specified element fullscreen

showRecorder

()
Show the recorder to the user. Useful if you want to temporarily show a hidden recorder- eg to let the user fix a problem with video capture settings

startRecorder

()
Start recording

Returns:

Promise Resolves when recording has started

startSessionRecorder

()
Start recording

Returns:

Promise Resolves when recording has started

stopRecorder

()
Stop the recording

Returns:

Promise A promise that resolves when upload is complete

stopSessionRecorder

()
Stop recording

Returns:

Promise Resolves when recording has been uploaded or timed out

whenPossibleToRecordObserver

()
Observer that starts recording once recorder is ready.

whenPossibleToRecordSessionObserver

()
Observer that starts recording once session recorder is ready.

Properties

assetsToExpand

String private

Inherited from Expand-assets (click for formatted description): app/mixins/expand-assets.js:98

Object describing which properties may need expansion

audioOnly

Number

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:158

Whether to do audio-only (vs also video) recording. Can be overridden by consuming frame.

Default: 0

audioSources

Object[]

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:268

Array of objects describing audio to play at the start of this frame. Each element describes a separate audio segment.

Sub-properties:

  • audioId String

    unique string identifying this audio segment

  • sources Object[]

    Array of {src: 'url', type: 'MIMEtype'} objects with audio sources for this segment.

    Can also give a single string 'filename', which will be expanded out to the appropriate array based on baseDir and audioTypes values; see audioTypes.

  • highlights Object[]

    Array of {'range': [startT, endT], 'image': 'imageId'} objects, where the imageId values correspond to the ids given in images

audioTypes

String[]

Inherited from Expand-assets (click for formatted description): app/mixins/expand-assets.js:126

List of audio types to expect for any audio specified just with a string rather than with a list of src/type objects. If audioTypes is ['typeA', 'typeB'] and an audio source is given as intro, the audio source will be expanded out to [ { src: 'baseDir' + 'typeA/intro.typeA', type: 'audio/typeA' }, { src: 'baseDir' + 'typeB/intro.typeB', type: 'audio/typeB' } ]

Default: ['mp3', 'ogg']

autoProceed

Boolean

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:258

Whether to proceed automatically after audio (and hide replay/next buttons)

autosave

Number private

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:149

Whether to autosave recordings. Can be overridden by consuming frame. TODO: eventually use this to set up non-recording option for previewing

Default: 1

backgroundImage

String

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:228

URL of background image; will be stretched to width of page

baseDir

String

Inherited from Expand-assets (click for formatted description): app/mixins/expand-assets.js:106

Base directory for where to find stimuli. Any image src values that are not full paths will be expanded by prefixing with baseDir + img/. Any audio/video src values provided as strings rather than objects with src and type will be expanded out to baseDir/avtype/[stub].avtype, where the potential avtypes are given by audioTypes and videoTypes. baseDir should include a trailing slash (e.g., http://stimuli.org/myexperiment/); if a value is provided that does not end in a slash, one will be added.

Default: ''

displayFullscreen

Boolean private

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:27

Whether to display this frame fullscreen

Default: false

displayFullscreenOverride

String

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:165

Set to true to display this frame in fullscreen mode, even if the frame type is not always displayed fullscreen. (For instance, you might use this to keep a survey between test trials in fullscreen mode.)

Default: false

doRecording

Boolean

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:248

Whether to do webcam recording (will wait for webcam connection before starting audio if so)

doUseCamera

Boolean

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:165

Whether to use the camera in this frame. Consuming frame should set this property to override if needed.

Default: true

endSessionRecording

Number

Inherited from Session-record (click for formatted description): app/mixins/session-record.js:98

Whether to end any session (multi-frame) recording at the end of this frame.

Default: false

fsButtonID

String private

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:35

The element ID of a button to show if the user leaves fullscreen mode

fullScreenElementId

String private

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:20

The element ID of the thing to make full screen (video element, div, etc)

generateProperties

String

Inherited from Exp-frame-base (click for formatted description): app/components/exp-frame-base/component.js:78

Function to generate additional properties for this frame (like {"kind": "exp-lookit-text"}) at the time the frame is initialized. Allows behavior of study to depend on what has happened so far (e.g., answers on a form or to previous test trials). Must be a valid Javascript function, returning an object, provided as a string.

Arguments that will be provided are: expData, sequence, child, pastSessions, conditions.

expData, sequence, and conditions are the same data as would be found in the session data shown on the Lookit experimenter interface under 'Individual Responses', except that they will only contain information up to this point in the study.

expData is an object consisting of frameId: frameData pairs; the data associated with a particular frame depends on the frame kind.

sequence is an ordered list of frameIds, corresponding to the keys in expData.

conditions is an object representing the data stored by any randomizer frames; keys are frameIds for randomizer frames and data stored depends on the randomizer used.

child is an object that has the following properties - use child.get(propertyName) to access:

  • additionalInformation: String; additional information field from child form
  • ageAtBirth: String; child's gestational age at birth in weeks. Possible values are "24" through "39", "na" (not sure or prefer not to answer), "<24" (under 24 weeks), and "40>" (40 or more weeks).
  • birthday: Date object
  • gender: "f" (female), "m" (male), "o" (other), or "na" (prefer not to answer)
  • givenName: String, child's given name/nickname
  • id: String, child UUID
  • languageList: String, space-separated list of languages child is exposed to (2-letter codes)
  • conditionList: String, space-separated list of conditions/characteristics
  • of child from registration form, as used in criteria expression, e.g. "autism_spectrum_disorder deaf multiple_birth"

pastSessions is a list of previous response objects for this child and this study, ordered starting from most recent (at index 0 is this session!). Each has properties (access as pastSessions[i].get(propertyName)):

  • completed: Boolean, whether they submitted an exit survey
  • completedConsentFrame: Boolean, whether they got through at least a consent frame
  • conditions: Object representing any conditions assigned by randomizer frames
  • createdOn: Date object
  • expData: Object consisting of frameId: frameData pairs
  • globalEventTimings: list of any events stored outside of individual frames - currently just used for attempts to leave the study early
  • sequence: ordered list of frameIds, corresponding to keys in expData
  • isPreview: Boolean, whether this is from a preview session (possible in the event this is an experimenter's account)

Example:

function(expData, sequence, child, pastSessions, conditions) {
    return {
       'blocks':
            [
                {
                    'text': 'Name: ' + child.get('givenName')
                },
                {
                    'text': 'Frame number: ' + sequence.length
                },
                {
                    'text': 'N past sessions: ' + pastSessions.length
                }
            ]
      };
  }

(This example is split across lines for readability; when added to JSON it would need to be on one line.)

Default: null

images

Object[]

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:350

Array of images to display and information about their placement

Sub-properties:

  • id String

    unique ID for this image. This will be used to refer to the choice made by the user, if any.

  • src String

    URL of image source (can be full URL, or stub to append to baseDir; see baseDir)

  • left String

    distance from left of story area to image center, as percentage of story area width - as string

  • height String

    image height, as percentage of story area height - as string

  • bottom String

    bottom margin, as percentage of story area height - as string

  • animate String

    animation to use at start of trial on this image, if any. If not provided, image is shown throughout trial. Options are 'fadein', 'fadeout', 'flyleft' (fly from left), and 'flyright'.

  • text String

    text to display above image, e.g. 'Click to hear what he said!' If omitted, no text is shown.

  • imageAudio Object[]

    sources Array of {src: 'url', type: 'MIMEtype'} objects with audio sources for audio to play when this image is clicked, if any. (Omit to not associate audio with this image.)

    Can also give a single string filename, which will be expanded out to the appropriate array based on baseDir and audioTypes values; see audioTypes.

  • requireAudio Boolean

    whether to require the user to click this image and complete the audio associated before proceeding to the next trial. (Incompatible with autoProceed.)

isChoiceFrame

Boolean

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:237

Whether this is a frame where the user needs to click to select one of the images before proceeding

Default: false

maxRecordingLength

Number

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:133

Maximum recording length in seconds. Can be overridden by consuming frame.

Default: 7200

maxUploadSeconds

Number

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:140

Maximum time allowed for video upload before proceeding, in seconds. Can be overridden by researcher, based on tradeoff between making families wait and losing data.

Default: 5

nPhase

Number

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:206

Phase number (just included as a convenience & sent to server, to make handling collected data simpler)

Default: 0

nTrial

Number

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:217

Trial number (just included as a convenience & sent to server, to make handling collected data simpler)

Default: 0

parameters

Object[]

Inherited from Exp-frame-base (click for formatted description): app/components/exp-frame-base/component.js:232

An object containing values for any parameters (variables) to use in this frame. Any property VALUES in this frame that match any of the property NAMES in parameters will be replaced by the corresponding parameter value. For example, suppose your frame is:

{
   'kind': 'FRAME_KIND',
   'parameters': {
       'FRAME_KIND': 'exp-lookit-text'
   }
}

Then the frame kind will be exp-lookit-text. This may be useful if you need to repeat values for different frame properties, especially if your frame is actually a randomizer or group. You may use parameters nested within objects (at any depth) or within lists.

You can also use selectors to randomly sample from or permute a list defined in parameters. Suppose STIMLIST is defined in parameters, e.g. a list of potential stimuli. Rather than just using STIMLIST as a value in your frames, you can also:

  • Select the Nth element (0-indexed) of the value of STIMLIST: (Will cause error if N >= THELIST.length)
   'parameterName': 'STIMLIST#N'
  • Select (uniformly) a random element of the value of STIMLIST:
   'parameterName': 'STIMLIST#RAND'
  • Set parameterName to a random permutation of the value of STIMLIST:
   'parameterName': 'STIMLIST#PERM'
  • Select the next element in a random permutation of the value of STIMLIST, which is used across all substitutions in this randomizer. This allows you, for instance, to provide a list of possible images in your parameterSet, and use a different one each frame with the subset/order randomized per participant. If more STIMLIST#UNIQ parameters than elements of STIMLIST are used, we loop back around to the start of the permutation generated for this randomizer.
   'parameterName': 'STIMLIST#UNIQ'

Default: {}

parentTextBlock

Object

Specific to this element. Defined in app/components/exp-lookit-dialogue-page/component.js:320

Text block to display to parent. (Each field is optional)

Sub-properties:

  • title String

    title to display

  • text String

    paragraph of text

  • emph Boolean

    whether to bold this paragraph

  • css Object

    object specifying any css properties to apply to this section, and their values - e.g. {'color': 'red', 'font-size': '12px'}.

recorder

VideoRecorder private

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:92

The recorder object, accessible to the consuming frame. Includes properties recorder.nWebcams, recorder.hasCamAccess, recorder.micChecked, recorder.connected.

recorderElement

String private

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:117

JQuery string to identify the recorder element.

Default: '#recorder'

recorderReady

Boolean private

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:125

Whether recorder has been set up yet. Automatically set when doing setup. Accessible to consuming frame.

selectNextFrame

String

Inherited from Exp-frame-base (click for formatted description): app/components/exp-frame-base/component.js:169

Function to select which frame index to go to when using the 'next' action on this frame. Allows flexible looping / short-circuiting based on what has happened so far in the study (e.g., once the child answers N questions correctly, move on to next segment). Must be a valid Javascript function, returning a number from 0 through frames.length - 1, provided as a string.

Arguments that will be provided are: frames, frameIndex, expData, sequence, child, pastSessions

frames is an ordered list of frame configurations for this study; each element is an object corresponding directly to a frame you defined in the JSON document for this study (but with any randomizer frames resolved into the particular frames that will be used this time).

frameIndex is the index in frames of the current frame

expData is an object consisting of frameId: frameData pairs; the data associated with a particular frame depends on the frame kind.

sequence is an ordered list of frameIds, corresponding to the keys in expData.

child is an object that has the following properties - use child.get(propertyName) to access:

  • additionalInformation: String; additional information field from child form
  • ageAtBirth: String; child's gestational age at birth in weeks. Possible values are "24" through "39", "na" (not sure or prefer not to answer), "<24" (under 24 weeks), and "40>" (40 or more weeks).
  • birthday: timestamp in format "Mon Apr 10 2017 20:00:00 GMT-0400 (Eastern Daylight Time)"
  • gender: "f" (female), "m" (male), "o" (other), or "na" (prefer not to answer)
  • givenName: String, child's given name/nickname
  • id: String, child UUID

pastSessions is a list of previous response objects for this child and this study, ordered starting from most recent (at index 0 is this session!). Each has properties (access as pastSessions[i].get(propertyName)):

  • completed: Boolean, whether they submitted an exit survey
  • completedConsentFrame: Boolean, whether they got through at least a consent frame
  • conditions: Object representing any conditions assigned by randomizer frames
  • createdOn: timestamp in format "Thu Apr 18 2019 12:33:26 GMT-0400 (Eastern Daylight Time)"
  • expData: Object consisting of frameId: frameData pairs
  • globalEventTimings: list of any events stored outside of individual frames - currently just used for attempts to leave the study early
  • sequence: ordered list of frameIds, corresponding to keys in expData

Example that just sends us to the last frame of the study no matter what: `"function(frames, frameIndex, frameData, expData, sequence, child, pastSessions) {return frames.length - 1;}"``

Default: null

sessionAudioOnly

Number

Inherited from Session-record (click for formatted description): app/mixins/session-record.js:108

Whether to do audio-only (vs also video) recording for session (multiframe) recording. Only used if starting session recording this frame.

Default: 0

sessionMaxUploadSeconds

Number

Inherited from Session-record (click for formatted description): app/mixins/session-record.js:89

Maximum time allowed for whole-session video upload before proceeding, in seconds. Can be overridden by researcher, based on tradeoff between making families wait and losing data.

Default: 10

showWaitForRecordingMessage

Boolean

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:191

Whether to initially show a message saying to wait until recording starts, covering the entire frame. This prevents participants from seeing any stimuli before recording begins. Only used if recording is being started immediately.

Default: true

showWaitForUploadMessage

Boolean

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:218

Whether to stop media and hide stimuli with a message saying to wait for video upload when stopping recording. Do NOT set this to true if end of recording does not correspond to end of the frame (e.g. during consent or observation frames) since it will hide everything upon stopping the recording!

Default: true

startRecordingAutomatically

Boolean

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:173

Whether to start recording ASAP (only applies if doUseCamera). Consuming frame should set to override if needed.

Default: false

startSessionRecording

Number

Inherited from Session-record (click for formatted description): app/mixins/session-record.js:82

Whether to start a session (multi-frame) recording as soon as possible upon loading this frame. This allows you to conduct video recording across multiple frames, simply specifying which frame to start and end on. Individual frames may also provide frame-specific recording capabilities; it is best NOT to conduct both a multiframe 'session' recording and frame-specific recording simultaneously as multiple video streams will eat up bandwidth. If you decide to use session recording, turn off recording for any frames that would otherwise record. There can be multiple session recordings in an experiment, e.g. from frames 1-3 and 5-10.

Default: false

stoppedRecording

Boolean private

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:108

Whether recording is stopped already, meaning it doesn't need to be re-stopped when destroying frame. This should be set to true by the consuming frame when video is stopped.

videoId

String private

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:181

A video ID to use for the current recording. Format is videoStream_<experimentId>_<frameId>_<sessionId>_timestampMS_RRR where RRR are random numeric digits.

videoList

List private

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:100

A list of all video IDs used in this mixin (a new one is created for each recording). Accessible to consuming frame.

videoTypes

String[]

Inherited from Expand-assets (click for formatted description): app/mixins/expand-assets.js:154

List of video types to expect for any audio specified just with a string rather than with a list of src/type objects. If videoTypes is ['typeA', 'typeB'] and a video source is given as intro, the video source will be expanded out to [ { src: 'baseDir' + 'typeA/intro.typeA', type: 'video/typeA' }, { src: 'baseDir' + 'typeB/intro.typeB', type: 'video/typeB' } ]

Default: ['mp4', 'webm']

waitForRecordingMessage

Boolean

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:200

[Only used if showWaitForRecordingMessage is true] Text to display while waiting for recording to begin.

Default: 'Please wait... <br><br> starting webcam recording'

waitForRecordingMessageColor

Boolean

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:207

[Only used if showWaitForRecordingMessage is true] Background color of screen while waiting for recording to begin. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value for acceptable syntax: can use either color names ('blue', 'red', 'green', etc.), or rgb hex values (e.g. '#800080' - include the '#'). The text on top of this will be either black or white depending on which will have higher contrast.

Default: 'white'

waitForUploadMessage

Boolean

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:227

[Only used if showWaitForUploadMessage is true] Text to display while waiting for recording to begin.

Default: 'Please wait... <br><br> uploading video'

waitForUploadMessageColor

String

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:234

[Only used if showWaitForUploadMessage is true] Background color of screen while waiting for recording to upload. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value for acceptable syntax: can use either color names ('blue', 'red', 'green', etc.), or rgb hex values (e.g. '#800080' - include the '#'). The text on top of this will be either black or white depending on which will have higher contrast.

Default: 'white'

waitForWebcamImage

String

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:245

[Only used if showWaitForUploadMessage and/or showWaitForRecordingMessage are true] Image to display along with any wait-for-recording or wait-for-upload message. Either waitForWebcamImage or waitForWebcamVideo can be specified. This can be either a full URL ('https://...') or just a filename, which will be assumed to be inside `baseDir/img/ if this frame otherwise supports use of baseDir`.

Default: ''

waitForWebcamVideo

String

Inherited from Video-record (click for formatted description): app/mixins/video-record.js:255

[Only used if showWaitForUploadMessage and/or showWaitForRecordingMessage are true] Video to display along with any wait-for-recording or wait-for-upload message (looping). Either waitForWebcamImage or waitForWebcamVideo can be specified. This can be either an array of `{'src': 'https://...', 'type': '...'}` objects (e.g. providing both webm and mp4 versions at specified URLS) or a single string relative to `baseDir/<EXT>/` if this frame otherwise supports use of `baseDir`.

Default: ''

Data keys collected

These are the fields that will be captured by this frame and sent back to the Lookit server. Each of these fields will correspond to one row of the CSV frame data for a given response - the row will have key set to the data key name, and value set to the value for this response. Equivalently, this data will be available in the exp_data field of the response JSON data.

currentlyHighlighted

Which image is selected at the end of the trial, or null if none is. This indicates the final selected choice for a choice trial.

eventTimings

Ordered list of events captured during this frame (oldest to newest). Each event is represented as an object with at least the properties {'eventType': EVENTNAME, 'timestamp': TIMESTAMP}. See Events tab for details of events that might be captured.

frameDuration

Duration between frame being inserted and call to next

frameType

Type of frame: EXIT (exit survey), CONSENT (consent or assent frame), or DEFAULT (anything else)

generatedProperties

Any properties generated via a custom generateProperties function provided to this frame (e.g., a score you computed to decide on feedback). In general will be null.

nPhase

Phase number as passed to this frame

nTrial

Number

Trial number as passed to this frame

Events

clickSpeaker

When one of the images is clicked during a choice frame

Event Payload:

completeMainAudio

When narration audio is completed

enteredFullscreen

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:84

Upon detecting change to fullscreen mode

hasCamAccess

Inherited from Session-record but overwritten in app/mixins/video-record.js:57

When recorder detects a change in camera access

Event Payload:

leftFullscreen

Inherited from Full-screen but overwritten in app/mixins/full-screen.js:96

Upon detecting change out of fullscreen mode

nextFrame

Move to next frame

pauseVideo

When pausing study, immediately before request to pause webcam recording

playSpeakerAudio

When image audio is played (recorded even if not completed)

Event Payload:

previousFrame

Move to previous frame

recorderReady

When video recorder has been installed

sessionRecorderReady

When session video recorder has been installed

startSessionRecording

When session video recorder has begun recording

startSpeakerAudio

When image audio is started

Event Payload:

stoppingCapture

Inherited from Session-record but overwritten in app/mixins/video-record.js:84

Just before stopping webcam video capture

stopSessionRecording

When session video recorder is stopped (upload may continue afterwards)

unpauseVideo

When unpausing study, immediately before request to resume webcam recording

videoStreamConnection

Inherited from Session-record but overwritten in app/mixins/video-record.js:64

When recorder detects a change in video stream connection status

Event Payload:

  • status String
    status of video stream connection, e.g. 'NetConnection.Connect.Success' if successful