@lookit/record 2.0.0 → 3.0.1

package/dist/consentVideo.d.ts

@@ -1,370 +0,0 @@
-import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
-declare const info: {
-    readonly name: "consent-video";
-    readonly version: string;
-    readonly parameters: {
-        readonly template: {
-            readonly type: ParameterType.STRING;
-            readonly default: "consent-template-5";
-        };
-        readonly locale: {
-            readonly type: ParameterType.STRING;
-            readonly default: "en-us";
-        };
-        readonly additional_video_privacy_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly datause: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly gdpr: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly gdpr_personal_data: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly gdpr_sensitive_data: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly PIName: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly include_databrary: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly institution: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly PIContact: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly payment: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly private_level_only: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly procedures: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly purpose: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly research_rights_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly risk_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly voluntary_participation: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly purpose_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly procedures_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly participation_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly benefits_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly risk_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly summary_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly additional_segments: {
-            readonly type: ParameterType.COMPLEX;
-            readonly array: true;
-            readonly default: readonly [];
-            readonly nested: {
-                readonly title: {
-                    readonly type: ParameterType.STRING;
-                    readonly default: "";
-                };
-                readonly text: {
-                    readonly type: ParameterType.STRING;
-                    readonly default: "";
-                };
-            };
-        };
-        readonly prompt_all_adults: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly prompt_only_adults: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly consent_statement_text: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly omit_injury_phrase: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-    };
-};
-type Info = typeof info;
-/** The video consent plugin. */
-export declare class VideoConsentPlugin implements JsPsychPlugin<Info> {
-    private readonly jsPsych;
-    static readonly info: {
-        readonly name: "consent-video";
-        readonly version: string;
-        readonly parameters: {
-            readonly template: {
-                readonly type: ParameterType.STRING;
-                readonly default: "consent-template-5";
-            };
-            readonly locale: {
-                readonly type: ParameterType.STRING;
-                readonly default: "en-us";
-            };
-            readonly additional_video_privacy_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly datause: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly gdpr: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly gdpr_personal_data: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly gdpr_sensitive_data: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly PIName: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly include_databrary: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly institution: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly PIContact: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly payment: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly private_level_only: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly procedures: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly purpose: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly research_rights_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly risk_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly voluntary_participation: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly purpose_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly procedures_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly participation_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly benefits_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly risk_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly summary_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly additional_segments: {
-                readonly type: ParameterType.COMPLEX;
-                readonly array: true;
-                readonly default: readonly [];
-                readonly nested: {
-                    readonly title: {
-                        readonly type: ParameterType.STRING;
-                        readonly default: "";
-                    };
-                    readonly text: {
-                        readonly type: ParameterType.STRING;
-                        readonly default: "";
-                    };
-                };
-            };
-            readonly prompt_all_adults: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly prompt_only_adults: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly consent_statement_text: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly omit_injury_phrase: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-        };
-    };
-    private readonly recorder;
-    private readonly video_container_id;
-    /**
-     * Instantiate video consent plugin.
-     *
-     * @param jsPsych - JsPsych object
-     */
-    constructor(jsPsych: JsPsych);
-    /**
-     * Create/Show trial view.
-     *
-     * @param display - HTML element for experiment.
-     * @param trial - Trial data including user supplied parameters.
-     */
-    trial(display: HTMLElement, trial: TrialType<Info>): void;
-    /**
-     * Retrieve video container element.
-     *
-     * @param display - HTML element for experiment.
-     * @returns Video container
-     */
-    private getVideoContainer;
-    /**
-     * Add webcam feed to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private recordFeed;
-    /**
-     * Playback Feed
-     *
-     * @param display - JsPsych display HTML element.
-     */
-    private playbackFeed;
-    /**
-     * Put back the webcam feed once the video recording has ended. This is used
-     * with the "ended" Event.
-     *
-     * @param display - JsPsych display HTML element.
-     * @returns Event function
-     */
-    private onEnded;
-    /**
-     * Retrieve button element from DOM.
-     *
-     * @param display - HTML element for experiment.
-     * @param id - Element id
-     * @returns Button element
-     */
-    private getButton;
-    /**
-     * Select and return the image element.
-     *
-     * @param display - HTML element for experiment.
-     * @param id - ID string of Image element
-     * @returns Image Element
-     */
-    private getImg;
-    /**
-     * Add record button to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private recordButton;
-    /**
-     * Set up play button to playback last recorded video.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private playButton;
-    /**
-     * Add stop button to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private stopButton;
-    /**
-     * Add next button to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private nextButton;
-    /**
-     * Mark the response in the lookit-api database as having completed the
-     * consent frame, then finish the trial.
-     */
-    private endTrial;
-    /**
-     * Add CHS type to experiment data. This will enable Lookit API to run the
-     * "consent" Frame Action Dispatcher method after the experiment has
-     * completed.
-     *
-     * @returns Object containing CHS type.
-     */
-    static chsData(): {
-        chs_type: string;
-    };
-}
-export {};

package/dist/errors.d.ts

@@ -1,149 +0,0 @@
-/** Error thrown when recorder is null. */
-export declare class RecorderInitializeError extends Error {
-    /**
-     * When there isn't a recorder, provide the user with an explanation of what
-     * they could do to resolve the issue.
-     */
-    constructor();
-}
-/** Error thrown when stream is inactive and recorder is started. */
-export declare class StreamInactiveInitializeError extends Error {
-    /**
-     * Error check on initialize. Attempting to validate recorder is ready to
-     * start recording.
-     */
-    constructor();
-}
-/** Error thrown when stream data is available and recorder is started. */
-export declare class StreamDataInitializeError extends Error {
-    /**
-     * Error check on recorder initialize. Attempt to validate recorder data array
-     * is empty and ready to start recording.
-     */
-    constructor();
-}
-/**
- * Error thrown when trying to stop an active session recording that cannot be
- * found.
- */
-export declare class NoSessionRecordingError extends Error {
-    /**
-     * When trying to stop a recording that isn't found, provide the user with an
-     * explanation of what they could do to resolve the issue.
-     */
-    constructor();
-}
-/**
- * Error thrown when trying to trying to start a recording while another is
- * already active.
- */
-export declare class ExistingRecordingError extends Error {
-    /**
-     * When trying to start a recording but there is already an active recording
-     * in progress, provide the user with an explanation of what they could do to
-     * resolve the issue.
-     */
-    constructor();
-}
-/**
- * Error thrown when trying to to stop the recorder and the stop promise doesn't
- * exist.
- */
-export declare class NoStopPromiseError extends Error {
-    /**
-     * When attempting to stop a recording but there's no stop promise to ensure
-     * the stop has completed.
-     */
-    constructor();
-}
-/**
- * Error thrown when attempting an action that relies on an input stream, such
- * as the mic volume check, but no such stream is found.
- */
-export declare class NoStreamError extends Error {
-    /**
-     * When attempting an action that requires an input stream, such as the mic
-     * check, but no stream is found.
-     */
-    constructor();
-}
-/**
- * Error thrown if there's a problem setting up the microphone input level
- * check.
- */
-export declare class MicCheckError extends Error {
-    /**
-     * Occurs if there's a problem setting up the mic check, including setting up
-     * the audio context and stream source, loading the audio worklet processor
-     * script, setting up the port message event handler, and resolving the
-     * promise chain via message events passed to onMicActivityLevel.
-     *
-     * @param err - Error passed into this error that is thrown in the catch
-     *   block, if any. Errors passed to catch blocks must have type unknown.
-     */
-    constructor(err: unknown);
-}
-/**
- * Error thrown when attempting to access S3 object and it's, unknowingly,
- * undefined.
- */
-export declare class S3UndefinedError extends Error {
-    /**
-     * Provide feed back when recorder attempts to use S3 object and it's
-     * undefined.
-     */
-    constructor();
-}
-/**
- * Error thrown when attempting to reset recorder, but its stream is still
- * active.
- */
-export declare class StreamActiveOnResetError extends Error {
-    /**
-     * This error will be thrown when developer attempts to reset recorder while
-     * active.
-     */
-    constructor();
-}
-/** Error thrown when attempting to select webcam element and it's not found. */
-export declare class NoWebCamElementError extends Error {
-    /**
-     * Error thrown when attempting to retrieve webcam element and it's not in the
-     * DOM.
-     */
-    constructor();
-}
-/**
- * Error thrown when attempting to create playback/download url and data array
- * is empty.
- */
-export declare class CreateURLError extends Error {
-    /**
-     * Throw this error when data array is empty and url still needs to be
-     * created. Sometimes this means the "reset()" method was called too early.
-     */
-    constructor();
-}
-/** Error thrown when video container couldn't be found. */
-export declare class VideoContainerNotFoundError extends Error {
-    /** No video container found. */
-    constructor();
-}
-/** Error thrown when button not found. */
-export declare class ButtonNotFoundError extends Error {
-    /**
-     * Button couldn't be found by ID field.
-     *
-     * @param id - HTML ID parameter.
-     */
-    constructor(id: string);
-}
-/** Throw Error when image couldn't be found. */
-export declare class ImageNotFoundError extends Error {
-    /**
-     * Error when image couldn't be found by ID field.
-     *
-     * @param id - HTML ID parameter
-     */
-    constructor(id: string);
-}

package/dist/mic_check.d.ts

@@ -1,33 +0,0 @@
-/**
- * Audio Worklet Processor class for processing audio input streams. This is
- * used by the Recorder to run a volume check on the microphone input stream.
- * Source:
- * https://www.webrtc-developers.com/how-to-know-if-my-microphone-works/#detect-noise-or-silence
- */
-export default class MicCheckProcessor extends AudioWorkletProcessor {
-    private _volume;
-    private _micChecked;
-    /** Constructor for the mic check processor. */
-    constructor();
-    /**
-     * Process method that implements the audio processing algorithm for the Audio
-     * Processor Worklet. "Although the method is not a part of the
-     * AudioWorkletProcessor interface, any implementation of
-     * AudioWorkletProcessor must provide a process() method." Source:
-     * https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletProcessor/process
-     * The process method can take the following arguments: inputs, outputs,
-     * parameters. Here we are only using inputs.
-     *
-     * @param inputs - An array of inputs from the audio stream (microphone)
-     *   connnected to the node. Each item in the inputs array is an array of
-     *   channels. Each channel is a Float32Array containing 128 samples. For
-     *   example, inputs[n][m][i] will access n-th input, m-th channel of that
-     *   input, and i-th sample of that channel.
-     * @returns Boolean indicating whether or not the Audio Worklet Node should
-     *   remain active, even if the User Agent thinks it is safe to shut down. In
-     *   this case, when the recorder decides that the mic check criteria has been
-     *   met, it will return false (processor should be shut down), otherwise it
-     *   will return true (processor should remain active).
-     */
-    process(inputs: Float32Array[][]): boolean;
-}