minor fixes to (auto)docs

lookit · Oct 27, 2020 · c83f42d · c83f42d
1 parent 0d8ab03
commit c83f42d
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 44 deletions.
diff --git a/app/components/exp-lookit-stop-recording/component.js b/app/components/exp-lookit-stop-recording/component.js
@@ -79,7 +79,22 @@ export default ExpFrameBaseComponent.extend(ExpandAssets, {
     fullScreenElementId: 'experiment-player',
     fsButtonID: 'fsButton',
 
+    /**
+     * @property {Boolean} startSessionRecording
+     * @private
+     */
+    /**
+     * @property {Boolean} endSessionRecording
+     * @private
+     */
     endSessionRecording: true,
+    /**
+     * 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.
+     * @property {Number} sessionMaxUploadSeconds
+     * @default 3000
+     */
     sessionMaxUploadSeconds: 3000, // 5 minutes - generous default for possibly long recording
 
     hasStartedUpload: false,

diff --git a/app/components/exp-lookit-video-assent/component.js b/app/components/exp-lookit-video-assent/component.js
@@ -90,48 +90,46 @@ specified using stubs MUST be organized as expected under baseDir/MEDIATYPE/file
 Example usage:
 
 ```json
-"frames": {
-    "video-assent": {
-        "kind": "exp-lookit-video-assent",
-            "pages": [
-                {
-                    "imgSrc": "jane_smith.png",
-                    "altText": "Jane Smith",
-                    "textBlocks": [
-                        {
-                            "text": "My name is Jane Smith. I am a scientist who studies why children love cats."
-                        }
-                    ],
-                    "audio": "narration_1"
-                },
-                {
-                    "imgSrc": "cats_game.png",
-                    "altText": "picture of sample game",
-                    "textBlocks": [
-                        {
-                            "text": "In this study, you will play a game about cats."
-                        }
-                    ]
-                },
-                {
-                    "showWebcam": true,
-                    "textBlocks": [
-                        {
-                            "text": "During the study, your webcam will record a video of you. We will watch this video later to see how much you love cats."
-                        }
-                    ]
-                }
-            ],
-            "baseDir": "https://s3.amazonaws.com/lookitcontents/cats/",
-            "videoTypes": [
-                "webm",
-                "mp4"
-            ],
-            "participationQuestion": "Do you want to participate in this study?",
-            "minimumYearsToAssent": 7
-        }
-    }
-}
+ "video-assent": {
+    "kind": "exp-lookit-video-assent",
+        "pages": [
+            {
+                "imgSrc": "two_cats.JPG",
+                "altText": "two cats",
+                "textBlocks": [
+                    {
+                        "text": "My name is Jane Smith. I am a scientist who studies why children love cats."
+                    }
+                ],
+                "audio": "sample_1",
+                "type": "audio/mp3"
+            },
+            {
+                "imgSrc": "three_cats.JPG",
+                "altText": "picture of sample game",
+                "textBlocks": [
+                    {
+                        "text": "In this study, you will play a game about cats."
+                    }
+                ]
+            },
+            {
+                "showWebcam": true,
+                "textBlocks": [
+                    {
+                        "text": "During the study, your webcam will record a video of you. We will watch this video later to see how much you love cats."
+                    }
+                ]
+            }
+        ],
+        "baseDir": "https://www.mit.edu/~kimscott/placeholderstimuli/",
+        "videoTypes": [
+            "webm",
+            "mp4"
+        ],
+        "participationQuestion": "Do you want to participate in this study?",
+        "minimumYearsToAssent": 7
+     }
 ```
 
 @class Exp-lookit-video-assent

diff --git a/app/mixins/session-record.js b/app/mixins/session-record.js
@@ -81,7 +81,7 @@ export default Ember.Mixin.create({
 
     /**
      * 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.
-     * @property {Number} startSessionRecording
+     * @property {Boolean} startSessionRecording
      * @default false
      */
     startSessionRecording: false,
@@ -97,7 +97,7 @@ export default Ember.Mixin.create({
 
     /**
      * Whether to end any session (multi-frame) recording at the end of this frame.
-     * @property {Number} endSessionRecording
+     * @property {Boolean} endSessionRecording
      * @default false
      */
     endSessionRecording: false,