jspsych 6.3.0 → 7.1.1

package/plugins/jspsych-audio-keyboard-response.js

@@ -1,212 +0,0 @@
-/**
- * jspsych-audio-keyboard-response
- * Josh de Leeuw
- *
- * plugin for playing an audio file and getting a keyboard response
- *
- * documentation: docs.jspsych.org
- *
- **/
-
-jsPsych.plugins["audio-keyboard-response"] = (function () {
-
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('audio-keyboard-response', 'stimulus', 'audio');
-
-  plugin.info = {
-    name: 'audio-keyboard-response',
-    description: '',
-    parameters: {
-      stimulus: {
-        type: jsPsych.plugins.parameterType.AUDIO,
-        pretty_name: 'Stimulus',
-        default: undefined,
-        description: 'The audio to be played.'
-      },
-      choices: {
-        type: jsPsych.plugins.parameterType.KEY,
-        pretty_name: 'Choices',
-        array: true,
-        default: jsPsych.ALL_KEYS,
-        description: 'The keys the subject is allowed to press to respond to the stimulus.'
-      },
-      prompt: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Prompt',
-        default: null,
-        description: 'Any content here will be displayed below the stimulus.'
-      },
-      trial_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Trial duration',
-        default: null,
-        description: 'The maximum duration to wait for a response.'
-      },
-      response_ends_trial: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Response ends trial',
-        default: true,
-        description: 'If true, the trial will end when user makes a response.'
-      },
-      trial_ends_after_audio: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Trial ends after audio',
-        default: false,
-        description: 'If true, then the trial will end as soon as the audio file finishes playing.'
-      },
-      response_allowed_while_playing: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Response allowed while playing',
-        default: true,
-        description: 'If true, then responses are allowed while the audio is playing. ' +
-          'If false, then the audio must finish playing before a response is accepted.'
-      }
-    }
-  }
-
-  plugin.trial = function (display_element, trial) {
-
-    // setup stimulus
-    var context = jsPsych.pluginAPI.audioContext();
-    var audio;
-
-    // store response
-    var response = {
-      rt: null,
-      key: null
-    };
-
-    // record webaudio context start time
-    var startTime;
-
-    // load audio file
-    jsPsych.pluginAPI.getAudioBuffer(trial.stimulus)
-      .then(function (buffer) {
-        if (context !== null) {
-          audio = context.createBufferSource();
-          audio.buffer = buffer;
-          audio.connect(context.destination);
-        } else {
-          audio = buffer;
-          audio.currentTime = 0;
-        }
-        setupTrial();
-      })
-      .catch(function (err) {
-        console.error(`Failed to load audio file "${trial.stimulus}". Try checking the file path. We recommend using the preload plugin to load audio files.`)
-        console.error(err)
-      });
-
-    function setupTrial() {
-      // set up end event if trial needs it
-      if (trial.trial_ends_after_audio) {
-        audio.addEventListener('ended', end_trial);
-      }
-
-      // show prompt if there is one
-      if (trial.prompt !== null) {
-        display_element.innerHTML = trial.prompt;
-      }
-
-      // start audio
-      if (context !== null) {
-        startTime = context.currentTime;
-        audio.start(startTime);
-      } else {
-        audio.play();
-      }
-
-      // start keyboard listener when trial starts or sound ends
-      if (trial.response_allowed_while_playing) {
-        setup_keyboard_listener();
-      } else if (!trial.trial_ends_after_audio) {
-        audio.addEventListener('ended', setup_keyboard_listener);
-      }
-
-      // end trial if time limit is set
-      if (trial.trial_duration !== null) {
-        jsPsych.pluginAPI.setTimeout(function () {
-          end_trial();
-        }, trial.trial_duration);
-      }
-    }
-
-
-    // function to end trial when it is time
-    function end_trial() {
-
-      // kill any remaining setTimeout handlers
-      jsPsych.pluginAPI.clearAllTimeouts();
-
-      // stop the audio file if it is playing
-      // remove end event listeners if they exist
-      if (context !== null) {
-        audio.stop();
-      } else {
-        audio.pause();
-      }
-
-      audio.removeEventListener('ended', end_trial);
-      audio.removeEventListener('ended', setup_keyboard_listener);
-
-
-      // kill keyboard listeners
-      jsPsych.pluginAPI.cancelAllKeyboardResponses();
-
-      // gather the data to store for the trial
-      if (context !== null && response.rt !== null) {
-        response.rt = Math.round(response.rt * 1000);
-      }
-      var trial_data = {
-        rt: response.rt,
-        stimulus: trial.stimulus,
-        response: response.key
-      };
-
-      // clear the display
-      display_element.innerHTML = '';
-
-      // move on to the next trial
-      jsPsych.finishTrial(trial_data);
-    }
-
-    // function to handle responses by the subject
-    function after_response(info) {
-
-      // only record the first response
-      if (response.key == null) {
-        response = info;
-      }
-
-      if (trial.response_ends_trial) {
-        end_trial();
-      }
-    };
-
-    function setup_keyboard_listener() {
-      // start the response listener
-      if (context !== null) {
-        jsPsych.pluginAPI.getKeyboardResponse({
-          callback_function: after_response,
-          valid_responses: trial.choices,
-          rt_method: 'audio',
-          persist: false,
-          allow_held_key: false,
-          audio_context: context,
-          audio_context_start_time: startTime
-        });
-      } else {
-        jsPsych.pluginAPI.getKeyboardResponse({
-          callback_function: after_response,
-          valid_responses: trial.choices,
-          rt_method: 'performance',
-          persist: false,
-          allow_held_key: false
-        });
-      }
-    }
-  };
-
-  return plugin;
-})();

package/plugins/jspsych-audio-slider-response.js

@@ -1,278 +0,0 @@
-jsPsych.plugins['audio-slider-response'] = (function () {
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('audio-slider-response', 'stimulus', 'audio');
-
-  plugin.info = {
-    name: 'audio-slider-response',
-    description: '',
-    parameters: {
-      stimulus: {
-        type: jsPsych.plugins.parameterType.AUDIO,
-        pretty_name: 'Stimulus',
-        default: undefined,
-        description: 'The image to be displayed'
-      },
-      min: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Min slider',
-        default: 0,
-        description: 'Sets the minimum value of the slider.'
-      },
-      max: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Max slider',
-        default: 100,
-        description: 'Sets the maximum value of the slider',
-      },
-      slider_start: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Slider starting value',
-        default: 50,
-        description: 'Sets the starting value of the slider',
-      },
-      step: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Step',
-        default: 1,
-        description: 'Sets the step of the slider'
-      },
-      labels: {
-        type: jsPsych.plugins.parameterType.HTML_STRING,
-        pretty_name: 'Labels',
-        default: [],
-        array: true,
-        description: 'Labels of the slider.',
-      },
-      slider_width: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Slider width',
-        default: null,
-        description: 'Width of the slider in pixels.'
-      },
-      button_label: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Button label',
-        default: 'Continue',
-        array: false,
-        description: 'Label of the button to advance.'
-      },
-      require_movement: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Require movement',
-        default: false,
-        description: 'If true, the participant will have to move the slider before continuing.'
-      },
-      prompt: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Prompt',
-        default: null,
-        description: 'Any content here will be displayed below the slider.'
-      },
-      trial_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Trial duration',
-        default: null,
-        description: 'How long to show the trial.'
-      },
-      response_ends_trial: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Response ends trial',
-        default: true,
-        description: 'If true, trial will end when user makes a response.'
-      },
-      response_allowed_while_playing: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Response allowed while playing',
-        default: true,
-        description: 'If true, then responses are allowed while the audio is playing. ' +
-          'If false, then the audio must finish playing before a response is accepted.'
-      }
-    }
-  }
-
-  plugin.trial = function (display_element, trial) {
-
-    // half of the thumb width value from jspsych.css, used to adjust the label positions
-    var half_thumb_width = 7.5;
-
-    // setup stimulus
-    var context = jsPsych.pluginAPI.audioContext();
-    var audio;
-
-    // record webaudio context start time
-    var startTime;
-
-    // for storing data related to response
-    var response;
-
-
-    // load audio file
-    jsPsych.pluginAPI.getAudioBuffer(trial.stimulus)
-      .then(function (buffer) {
-        if (context !== null) {
-          audio = context.createBufferSource();
-          audio.buffer = buffer;
-          audio.connect(context.destination);
-        } else {
-          audio = buffer;
-          audio.currentTime = 0;
-        }
-        setupTrial();
-      })
-      .catch(function (err) {
-        console.error(`Failed to load audio file "${trial.stimulus}". Try checking the file path. We recommend using the preload plugin to load audio files.`)
-        console.error(err)
-      });
-
-    function setupTrial() {
-
-
-      // set up end event if trial needs it
-      if (trial.trial_ends_after_audio) {
-
-        audio.addEventListener('ended', end_trial);
-
-      }
-
-      // enable slider after audio ends if necessary
-      if ((!trial.response_allowed_while_playing) & (!trial.trial_ends_after_audio)) {
-
-        audio.addEventListener('ended', enable_slider);
-
-      }
-
-      var html = '<div id="jspsych-audio-slider-response-wrapper" style="margin: 100px 0px;">';
-      html += '<div class="jspsych-audio-slider-response-container" style="position:relative; margin: 0 auto 3em auto; width:';
-      if (trial.slider_width !== null) {
-        html += trial.slider_width + 'px;';
-      } else {
-        html += 'auto;';
-      }
-      html += '">';
-      html += '<input type="range" class="jspsych-slider" value="' + trial.slider_start + '" min="' + trial.min + '" max="' + trial.max + '" step="' + trial.step + '" id="jspsych-audio-slider-response-response"';
-      if (!trial.response_allowed_while_playing) {
-        html += ' disabled';
-      }
-      html += '></input><div>'
-      for (var j = 0; j < trial.labels.length; j++) {
-        var label_width_perc = 100 / (trial.labels.length - 1);
-        var percent_of_range = j * (100 / (trial.labels.length - 1));
-        var percent_dist_from_center = ((percent_of_range - 50) / 50) * 100;
-        var offset = (percent_dist_from_center * half_thumb_width) / 100;
-        html += '<div style="border: 1px solid transparent; display: inline-block; position: absolute; ' +
-          'left:calc(' + percent_of_range + '% - (' + label_width_perc + '% / 2) - ' + offset + 'px); text-align: center; width: ' + label_width_perc + '%;">';
-        html += '<span style="text-align: center; font-size: 80%;">' + trial.labels[j] + '</span>';
-        html += '</div>'
-      }
-      html += '</div>';
-      html += '</div>';
-      html += '</div>';
-
-      if (trial.prompt !== null) {
-        html += trial.prompt;
-      }
-
-      // add submit button
-      var next_disabled_attribute = "";
-      if (trial.require_movement | !trial.response_allowed_while_playing) {
-        next_disabled_attribute = "disabled";
-      }
-      html += '<button id="jspsych-audio-slider-response-next" class="jspsych-btn" ' + next_disabled_attribute + '>' + trial.button_label + '</button>';
-
-      display_element.innerHTML = html;
-
-      response = {
-        rt: null,
-        response: null
-      };
-
-      if (!trial.response_allowed_while_playing) {
-        display_element.querySelector('#jspsych-audio-slider-response-response').disabled = true;
-        display_element.querySelector('#jspsych-audio-slider-response-next').disabled = true;
-      }
-
-      if (trial.require_movement) {
-        display_element.querySelector('#jspsych-audio-slider-response-response').addEventListener('click', function () {
-          display_element.querySelector('#jspsych-audio-slider-response-next').disabled = false;
-        });
-      }
-
-      display_element.querySelector('#jspsych-audio-slider-response-next').addEventListener('click', function () {
-        // measure response time
-        var endTime = performance.now();
-        var rt = endTime - startTime;
-        if (context !== null) {
-          endTime = context.currentTime;
-          rt = Math.round((endTime - startTime) * 1000);
-        }
-        response.rt = rt;
-        response.response = display_element.querySelector('#jspsych-audio-slider-response-response').valueAsNumber;
-
-        if (trial.response_ends_trial) {
-          end_trial();
-        } else {
-          display_element.querySelector('#jspsych-audio-slider-response-next').disabled = true;
-        }
-
-      });
-
-      startTime = performance.now();
-      // start audio
-      if (context !== null) {
-        startTime = context.currentTime;
-        audio.start(startTime);
-      } else {
-        audio.play();
-      }
-
-      // end trial if trial_duration is set
-      if (trial.trial_duration !== null) {
-        jsPsych.pluginAPI.setTimeout(function () {
-          end_trial();
-        }, trial.trial_duration);
-      }
-    }
-
-    // function to enable slider after audio ends
-    function enable_slider() {
-      document.querySelector('#jspsych-audio-slider-response-response').disabled = false;
-      if (!trial.require_movement) {
-        document.querySelector('#jspsych-audio-slider-response-next').disabled = false;
-      }
-    }
-
-    function end_trial() {
-
-      // kill any remaining setTimeout handlers
-      jsPsych.pluginAPI.clearAllTimeouts();
-
-      // stop the audio file if it is playing
-      // remove end event listeners if they exist
-      if (context !== null) {
-        audio.stop();
-      } else {
-        audio.pause();
-      }
-
-      audio.removeEventListener('ended', end_trial);
-      audio.removeEventListener('ended', enable_slider);
-
-
-      // save data
-      var trialdata = {
-        rt: response.rt,
-        stimulus: trial.stimulus,
-        slider_start: trial.slider_start,
-        response: response.response
-      };
-
-      display_element.innerHTML = '';
-
-      // next trial
-      jsPsych.finishTrial(trialdata);
-    }
-  };
-
-  return plugin;
-})();

package/plugins/jspsych-call-function.js

@@ -1,58 +0,0 @@
-/**
- * jspsych-call-function
- * plugin for calling an arbitrary function during a jspsych experiment
- * Josh de Leeuw
- *
- * documentation: docs.jspsych.org
- *
- **/
-
-jsPsych.plugins['call-function'] = (function() {
-
-  var plugin = {};
-
-  plugin.info = {
-    name: 'call-function',
-    description: '',
-    parameters: {
-      func: {
-        type: jsPsych.plugins.parameterType.FUNCTION,
-        pretty_name: 'Function',
-        default: undefined,
-        description: 'Function to call'
-      },
-      async: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Asynchronous',
-        default: false,
-        description: 'Is the function call asynchronous?'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-    trial.post_trial_gap = 0;
-    var return_val;
-
-    if(trial.async){
-      var done = function(data){
-        return_val = data;
-        end_trial();    
-      }
-      trial.func(done);
-    } else {
-      return_val = trial.func();
-      end_trial();
-    }
-    
-    function end_trial(){
-      var trial_data = {
-        value: return_val
-      };
-  
-      jsPsych.finishTrial(trial_data);
-    }
-  };
-
-  return plugin;
-})();