@lookit/record 1.0.0 → 3.0.0

package/dist/video_config.d.ts

@@ -1,296 +0,0 @@
-import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
-declare const info: {
-    readonly name: "video-config-plugin";
-    readonly version: string;
-    readonly parameters: {
-        readonly troubleshooting_intro: {
-            /**
-             * Optional string to appear at the start of the "Setup tips and
-             * troubleshooting" section.
-             */
-            readonly type: ParameterType.HTML_STRING;
-            readonly default: "";
-            readonly pretty_name: "Troubleshooting Intro";
-        };
-    };
-    readonly data: {
-        readonly rt: {
-            readonly type: ParameterType.INT;
-        };
-        readonly camId: {
-            readonly type: ParameterType.STRING;
-        };
-        readonly micId: {
-            readonly type: ParameterType.STRING;
-        };
-    };
-};
-type Info = typeof info;
-export type VideoConsentTrialType = TrialType<Info>;
-/**
- * **Video Config**.
- *
- * CHS jsPsych plugin for presenting a video recording configuration plugin, to
- * help participants set up their webcam and microphone before beginning a study
- * that includes video/audio recording. This plugin must be used before any
- * other trials in the experiment can access the camera/mic.
- *
- * @author Becky Gilbert
- * @see {@link https://github.com/lookit/lookit-jspsych/blob/main/packages/video-config/README.md video-config plugin documentation on Github}
- */
-export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
-    private jsPsych;
-    static info: {
-        readonly name: "video-config-plugin";
-        readonly version: string;
-        readonly parameters: {
-            readonly troubleshooting_intro: {
-                /**
-                 * Optional string to appear at the start of the "Setup tips and
-                 * troubleshooting" section.
-                 */
-                readonly type: ParameterType.HTML_STRING;
-                readonly default: "";
-                readonly pretty_name: "Troubleshooting Intro";
-            };
-        };
-        readonly data: {
-            readonly rt: {
-                readonly type: ParameterType.INT;
-            };
-            readonly camId: {
-                readonly type: ParameterType.STRING;
-            };
-            readonly micId: {
-                readonly type: ParameterType.STRING;
-            };
-        };
-    };
-    private display_el;
-    private start_time;
-    private recorder;
-    private hasReloaded;
-    private response;
-    private camId;
-    private micId;
-    private minVolume;
-    private micChecked;
-    private processorNode;
-    private webcam_container_id;
-    private reload_button_id_text;
-    private reload_button_id_cam;
-    private camera_selection_id;
-    private mic_selection_id;
-    private next_button_id;
-    private error_msg_div_id;
-    private step1_id;
-    private step2_id;
-    private step3_id;
-    private step_complete_class;
-    private step_complete_text;
-    private waiting_for_access_msg;
-    private checking_mic_msg;
-    private access_problem_msg;
-    private setup_problem_msg;
-    /**
-     * Constructor for video config plugin.
-     *
-     * @param jsPsych - JsPsych object automatically passed into the constructor.
-     */
-    constructor(jsPsych: JsPsych);
-    /**
-     * Trial method called by jsPsych.
-     *
-     * @param display_element - Element where the jsPsych trial will be displayed.
-     * @param trial - Trial object with parameters/values.
-     */
-    trial(display_element: HTMLElement, trial: VideoConsentTrialType): void;
-    /**
-     * Add HTML content to the page.
-     *
-     * @param troubleshooting_intro - Troubleshooting intro parameter from the
-     *   Trial object.
-     */
-    private addHtmlContent;
-    /** Add event listeners to elements after they've been added to the page. */
-    private addEventListeners;
-    /**
-     * Access media devices, populate device lists, setup the jsPsych
-     * camera/stream and Recorder instance, and run the permissions/mic checks.
-     * This is run when the trial first loads and anytime the user clicks the
-     * reload recorder button.
-     *
-     * 1. Request permissions.
-     * 2. Enumerate devices and populate the device selection elements with options.
-     * 3. Initialize the jsPsych recorder with the current/selected devices, and
-     *    create a new Recorder.
-     * 4. Run the stream checks. (If completed successfully, this will clear any
-     *    error messages and enable the next button).
-     */
-    private setupRecorder;
-    /**
-     * Request permission to use the webcam and/or microphone. This can be used
-     * with and without specific device selection (and other constraints).
-     *
-     * @param constraints - Media stream constraints object with 'video' and
-     *   'audio' properties, whose values can be boolean or a
-     *   MediaTrackConstraints object or undefined.
-     * @param constraints.video - If false, do not include video. If true, use the
-     *   default webcam device. If a media track constraints object is passed,
-     *   then it can contain the properties of all media tracks and video tracks:
-     *   https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints.
-     * @param constraints.audio - If false, do not include audio. If true, use the
-     *   default mic device. If a media track constraints object is passed, then
-     *   it can contain the properties of all media tracks and audio tracks:
-     *   https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints.
-     * @returns Camera/microphone stream.
-     */
-    private requestPermission;
-    /**
-     * Receives device lists and populates the device selection HTML elements.
-     * This is run when the trial loads, and in response to changes to the
-     * available devices.
-     *
-     * @param devices - Object with properties 'cameras' and 'mics', which are
-     *   arrays containing lists of available devices.
-     * @param devices.cameras - Array of MediaDeviceInfo objects for webcam/video
-     *   input devices.
-     * @param devices.mics - Array of MediaDeviceInfo objects for mic/audio input
-     *   devices.
-     */
-    private updateDeviceSelection;
-    /**
-     * Takes the selected device IDs from the camera/mic selection elements, gets
-     * the streams for these devices, sets these as the input devices via
-     * jsPsych.pluginAPI.initializeCameraRecorder, and creates a new Recorder.
-     */
-    private setDevices;
-    /**
-     * Run the stream checks after permissions have been granted and devices have
-     * been selected. This is run when the trial first loads, after permissions
-     * are granted, and in response to changes to the device selection. It checks
-     * for (1) the existence of the required streams, (2) minimum microphone input
-     * level (when audio is included), and (3) media permissions (via recorder
-     * destroy/reload). This runs the stream checks, updates the info/error
-     * messages, enables the next button, and handles errors. This is factored out
-     * of the set up process (setupRecorder) because it is also triggered by a
-     * change in the cam/mic device selection.
-     */
-    private runStreamChecks;
-    /**
-     * If there is a change to the available devices, then we need to: (1) get the
-     * updated device lists, and (2) update the select elements with these list
-     * elements.
-     */
-    private onDeviceChange;
-    /**
-     * Gets the lists of available cameras and mics (via Media Devices
-     * 'enumerateDevices'). These lists can be used to populate camera/mic
-     * selection elements.
-     *
-     * @param include_audio - Whether or not to include audio capture (mic)
-     *   devices. Optional, default is true.
-     * @param include_camera - Whether or not to include the webcam (video)
-     *   devices. Optional, default is true.
-     * @returns Object with properties 'cameras' and 'mics', containing lists of
-     *   available devices.
-     */
-    private getDeviceLists;
-    /**
-     * Initialize recorder using the jsPsych plugin API. This must be called
-     * before running the stream checks.
-     *
-     * @param stream - Media stream returned from getUserMedia that should be used
-     *   to set up the jsPsych recorder.
-     * @param opts - Media recorder options to use when setting up the recorder.
-     */
-    initializeAndCreateRecorder: (stream: MediaStream, opts?: MediaRecorderOptions) => void;
-    /**
-     * Perform a sound check on the audio input (microphone).
-     *
-     * @param minVol - Minimum mic activity needed to reach the mic check
-     *   threshold (optional). Default is `this.minVolume`
-     * @returns Promise that resolves when the mic check is complete because the
-     *   audio stream has reached the required minimum level.
-     */
-    private checkMic;
-    /**
-     * Handle the mic level messages that are sent via an AudioWorkletProcessor.
-     * This checks the current level against the minimum threshold, and if the
-     * threshold is met, sets the micChecked property to true and resolves the
-     * checkMic promise.
-     *
-     * @param currentActivityLevel - Microphone activity level calculated by the
-     *   processor node.
-     * @param minVolume - Minimum microphone activity level needed to pass the
-     *   microphone check.
-     * @param resolve - Resolve callback function for Promise returned by the
-     *   checkMic method.
-     */
-    private onMicActivityLevel;
-    /**
-     * Creates the processor node for the mic check input level processing, and
-     * connects the microphone to the processor node.
-     *
-     * @param audioContext - Audio context that was created in checkMic. This is
-     *   used to create the processor node.
-     * @param microphone - Microphone audio stream source, created in checkMic.
-     *   The processor node will be connected to this source.
-     * @returns Promise that resolves after the processor node has been created,
-     *   and the microphone audio stream source is connected to the processor node
-     *   and audio context destination.
-     */
-    private createConnectProcessor;
-    /**
-     * Set up the port's on message event handler for the mic check processor
-     * node. This adds the event related callback, which calls onMicActivityLevel
-     * with the event data.
-     *
-     * @param minVol - Minimum volume level (RMS amplitude) passed from checkMic.
-     * @returns Promise that resolves from inside the onMicActivityLevel callback,
-     *   when the mic stream input level has reached the threshold.
-     */
-    private setupPortOnMessage;
-    /**
-     * Update the instructions for a given step, based on whether or not the check
-     * has passed for that step.
-     *
-     * @param step - Which instructions step to update. 1 = stream access, 2 =
-     *   reload complete, 3 = mic level check.
-     * @param checkPassed - Whether or not the mic check has passed.
-     */
-    private updateInstructions;
-    /**
-     * Update the errors/messages div with information for the user about the
-     * camera/mic checks.
-     *
-     * @param errorMsg - Message to display in the error message div. Pass an
-     *   empty string to clear any existing errors/messages.
-     */
-    private updateErrors;
-    /**
-     * Collect trial data and end the trial. JsPsych.finishTrial takes the
-     * plugin's trial data as an argument, ends the trial, and moves on to the
-     * next trial in the experiment timeline.
-     */
-    private endTrial;
-    /**
-     * Destroy the recorder. This is used to stop the streams at the end of the
-     * trial, and as part of the reload check to test the user's browser
-     * permissions by mimicking the start of a new trial (i.e. stop streams and
-     * then create a new Recorder instance).
-     */
-    private destroyRecorder;
-    /** Handle the next button click event. */
-    private nextButtonClick;
-    /** Handle the reload recorder button click event. */
-    private reloadButtonClick;
-    /**
-     * Toggle the next button disable property.
-     *
-     * @param enable - Whether to enable (true) or disable (false) the next
-     *   button.
-     */
-    private enableNext;
-}
-export {};