@jspsych/plugin-audio-keyboard-response 1.0.0

package/dist/index.browser.js

@@ -0,0 +1,198 @@
+var jsPsychAudioKeyboardResponse = (function (jspsych) {
+  'use strict';
+
+  const info = {
+      name: "audio-keyboard-response",
+      parameters: {
+          /** The audio file to be played. */
+          stimulus: {
+              type: jspsych.ParameterType.AUDIO,
+              pretty_name: "Stimulus",
+              default: undefined,
+          },
+          /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */
+          choices: {
+              type: jspsych.ParameterType.KEYS,
+              pretty_name: "Choices",
+              default: "ALL_KEYS",
+          },
+          /** Any content here will be displayed below the stimulus. */
+          prompt: {
+              type: jspsych.ParameterType.HTML_STRING,
+              pretty_name: "Prompt",
+              default: null,
+          },
+          /** The maximum duration to wait for a response. */
+          trial_duration: {
+              type: jspsych.ParameterType.INT,
+              pretty_name: "Trial duration",
+              default: null,
+          },
+          /** If true, the trial will end when user makes a response. */
+          response_ends_trial: {
+              type: jspsych.ParameterType.BOOL,
+              pretty_name: "Response ends trial",
+              default: true,
+          },
+          /** If true, then the trial will end as soon as the audio file finishes playing. */
+          trial_ends_after_audio: {
+              type: jspsych.ParameterType.BOOL,
+              pretty_name: "Trial ends after audio",
+              default: false,
+          },
+          /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */
+          response_allowed_while_playing: {
+              type: jspsych.ParameterType.BOOL,
+              pretty_name: "Response allowed while playing",
+              default: true,
+          },
+      },
+  };
+  /**
+   * **audio-keyboard-response**
+   *
+   * jsPsych plugin for playing an audio file and getting a keyboard response
+   *
+   * @author Josh de Leeuw
+   * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}
+   */
+  class AudioKeyboardResponsePlugin {
+      constructor(jsPsych) {
+          this.jsPsych = jsPsych;
+      }
+      trial(display_element, trial, on_load) {
+          // hold the .resolve() function from the Promise that ends the trial
+          let trial_complete;
+          // setup stimulus
+          var context = this.jsPsych.pluginAPI.audioContext();
+          var audio;
+          // store response
+          var response = {
+              rt: null,
+              key: null,
+          };
+          // record webaudio context start time
+          var startTime;
+          // load audio file
+          this.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);
+          });
+          const 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) {
+                  this.jsPsych.pluginAPI.setTimeout(function () {
+                      end_trial();
+                  }, trial.trial_duration);
+              }
+              on_load();
+          };
+          // function to end trial when it is time
+          const end_trial = () => {
+              // kill any remaining setTimeout handlers
+              this.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
+              this.jsPsych.pluginAPI.cancelAllKeyboardResponses();
+              // gather the data to store for the trial
+              var trial_data = {
+                  rt: response.rt,
+                  stimulus: trial.stimulus,
+                  response: response.key,
+              };
+              // clear the display
+              display_element.innerHTML = "";
+              // move on to the next trial
+              this.jsPsych.finishTrial(trial_data);
+              trial_complete();
+          };
+          // 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();
+              }
+          }
+          const setup_keyboard_listener = () => {
+              // start the response listener
+              if (context !== null) {
+                  this.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 {
+                  this.jsPsych.pluginAPI.getKeyboardResponse({
+                      callback_function: after_response,
+                      valid_responses: trial.choices,
+                      rt_method: "performance",
+                      persist: false,
+                      allow_held_key: false,
+                  });
+              }
+          };
+          return new Promise((resolve) => {
+              trial_complete = resolve;
+          });
+      }
+  }
+  AudioKeyboardResponsePlugin.info = info;
+
+  return AudioKeyboardResponsePlugin;
+
+})(jsPsychModule);
+//# sourceMappingURL=index.browser.js.map

package/dist/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.js","sources":["../src/index.ts"],"sourcesContent":["import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from \"jspsych\";\n\nconst info = <const>{\n  name: \"audio-keyboard-response\",\n  parameters: {\n    /** The audio file to be played. */\n    stimulus: {\n      type: ParameterType.AUDIO,\n      pretty_name: \"Stimulus\",\n      default: undefined,\n    },\n    /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */\n    choices: {\n      type: ParameterType.KEYS,\n      pretty_name: \"Choices\",\n      default: \"ALL_KEYS\",\n    },\n    /** Any content here will be displayed below the stimulus. */\n    prompt: {\n      type: ParameterType.HTML_STRING,\n      pretty_name: \"Prompt\",\n      default: null,\n    },\n    /** The maximum duration to wait for a response. */\n    trial_duration: {\n      type: ParameterType.INT,\n      pretty_name: \"Trial duration\",\n      default: null,\n    },\n    /** If true, the trial will end when user makes a response. */\n    response_ends_trial: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response ends trial\",\n      default: true,\n    },\n    /** If true, then the trial will end as soon as the audio file finishes playing. */\n    trial_ends_after_audio: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Trial ends after audio\",\n      default: false,\n    },\n    /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */\n    response_allowed_while_playing: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response allowed while playing\",\n      default: true,\n    },\n  },\n};\n\ntype Info = typeof info;\n\n/**\n * **audio-keyboard-response**\n *\n * jsPsych plugin for playing an audio file and getting a keyboard response\n *\n * @author Josh de Leeuw\n * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}\n */\nclass AudioKeyboardResponsePlugin implements JsPsychPlugin<Info> {\n  static info = info;\n\n  constructor(private jsPsych: JsPsych) {}\n\n  trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void) {\n    // hold the .resolve() function from the Promise that ends the trial\n    let trial_complete;\n\n    // setup stimulus\n    var context = this.jsPsych.pluginAPI.audioContext();\n    var audio;\n\n    // store response\n    var response = {\n      rt: null,\n      key: null,\n    };\n\n    // record webaudio context start time\n    var startTime;\n\n    // load audio file\n    this.jsPsych.pluginAPI\n      .getAudioBuffer(trial.stimulus)\n      .then(function (buffer) {\n        if (context !== null) {\n          audio = context.createBufferSource();\n          audio.buffer = buffer;\n          audio.connect(context.destination);\n        } else {\n          audio = buffer;\n          audio.currentTime = 0;\n        }\n        setupTrial();\n      })\n      .catch(function (err) {\n        console.error(\n          `Failed to load audio file \"${trial.stimulus}\". Try checking the file path. We recommend using the preload plugin to load audio files.`\n        );\n        console.error(err);\n      });\n\n    const setupTrial = () => {\n      // set up end event if trial needs it\n      if (trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", end_trial);\n      }\n\n      // show prompt if there is one\n      if (trial.prompt !== null) {\n        display_element.innerHTML = trial.prompt;\n      }\n\n      // start audio\n      if (context !== null) {\n        startTime = context.currentTime;\n        audio.start(startTime);\n      } else {\n        audio.play();\n      }\n\n      // start keyboard listener when trial starts or sound ends\n      if (trial.response_allowed_while_playing) {\n        setup_keyboard_listener();\n      } else if (!trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", setup_keyboard_listener);\n      }\n\n      // end trial if time limit is set\n      if (trial.trial_duration !== null) {\n        this.jsPsych.pluginAPI.setTimeout(function () {\n          end_trial();\n        }, trial.trial_duration);\n      }\n\n      on_load();\n    };\n\n    // function to end trial when it is time\n    const end_trial = () => {\n      // kill any remaining setTimeout handlers\n      this.jsPsych.pluginAPI.clearAllTimeouts();\n\n      // stop the audio file if it is playing\n      // remove end event listeners if they exist\n      if (context !== null) {\n        audio.stop();\n      } else {\n        audio.pause();\n      }\n\n      audio.removeEventListener(\"ended\", end_trial);\n      audio.removeEventListener(\"ended\", setup_keyboard_listener);\n\n      // kill keyboard listeners\n      this.jsPsych.pluginAPI.cancelAllKeyboardResponses();\n\n      // gather the data to store for the trial\n      var trial_data = {\n        rt: response.rt,\n        stimulus: trial.stimulus,\n        response: response.key,\n      };\n\n      // clear the display\n      display_element.innerHTML = \"\";\n\n      // move on to the next trial\n      this.jsPsych.finishTrial(trial_data);\n\n      trial_complete();\n    };\n\n    // function to handle responses by the subject\n    function after_response(info) {\n      // only record the first response\n      if (response.key == null) {\n        response = info;\n      }\n\n      if (trial.response_ends_trial) {\n        end_trial();\n      }\n    }\n\n    const setup_keyboard_listener = () => {\n      // start the response listener\n      if (context !== null) {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"audio\",\n          persist: false,\n          allow_held_key: false,\n          audio_context: context,\n          audio_context_start_time: startTime,\n        });\n      } else {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"performance\",\n          persist: false,\n          allow_held_key: false,\n        });\n      }\n    };\n\n    return new Promise((resolve) => {\n      trial_complete = resolve;\n    });\n  }\n}\n\nexport default AudioKeyboardResponsePlugin;\n"],"names":["ParameterType"],"mappings":";;;EAEA,MAAM,IAAI,GAAU;MAClB,IAAI,EAAE,yBAAyB;MAC/B,UAAU,EAAE;;UAEV,QAAQ,EAAE;cACR,IAAI,EAAEA,qBAAa,CAAC,KAAK;cACzB,WAAW,EAAE,UAAU;cACvB,OAAO,EAAE,SAAS;WACnB;;UAED,OAAO,EAAE;cACP,IAAI,EAAEA,qBAAa,CAAC,IAAI;cACxB,WAAW,EAAE,SAAS;cACtB,OAAO,EAAE,UAAU;WACpB;;UAED,MAAM,EAAE;cACN,IAAI,EAAEA,qBAAa,CAAC,WAAW;cAC/B,WAAW,EAAE,QAAQ;cACrB,OAAO,EAAE,IAAI;WACd;;UAED,cAAc,EAAE;cACd,IAAI,EAAEA,qBAAa,CAAC,GAAG;cACvB,WAAW,EAAE,gBAAgB;cAC7B,OAAO,EAAE,IAAI;WACd;;UAED,mBAAmB,EAAE;cACnB,IAAI,EAAEA,qBAAa,CAAC,IAAI;cACxB,WAAW,EAAE,qBAAqB;cAClC,OAAO,EAAE,IAAI;WACd;;UAED,sBAAsB,EAAE;cACtB,IAAI,EAAEA,qBAAa,CAAC,IAAI;cACxB,WAAW,EAAE,wBAAwB;cACrC,OAAO,EAAE,KAAK;WACf;;UAED,8BAA8B,EAAE;cAC9B,IAAI,EAAEA,qBAAa,CAAC,IAAI;cACxB,WAAW,EAAE,gCAAgC;cAC7C,OAAO,EAAE,IAAI;WACd;OACF;GACF,CAAC;EAIF;;;;;;;;EAQA,MAAM,2BAA2B;MAG/B,YAAoB,OAAgB;UAAhB,YAAO,GAAP,OAAO,CAAS;OAAI;MAExC,KAAK,CAAC,eAA4B,EAAE,KAAsB,EAAE,OAAmB;;UAE7E,IAAI,cAAc,CAAC;;UAGnB,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;UACpD,IAAI,KAAK,CAAC;;UAGV,IAAI,QAAQ,GAAG;cACb,EAAE,EAAE,IAAI;cACR,GAAG,EAAE,IAAI;WACV,CAAC;;UAGF,IAAI,SAAS,CAAC;;UAGd,IAAI,CAAC,OAAO,CAAC,SAAS;eACnB,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC;eAC9B,IAAI,CAAC,UAAU,MAAM;cACpB,IAAI,OAAO,KAAK,IAAI,EAAE;kBACpB,KAAK,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;kBACrC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;kBACtB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;eACpC;mBAAM;kBACL,KAAK,GAAG,MAAM,CAAC;kBACf,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;eACvB;cACD,UAAU,EAAE,CAAC;WACd,CAAC;eACD,KAAK,CAAC,UAAU,GAAG;cAClB,OAAO,CAAC,KAAK,CACX,8BAA8B,KAAK,CAAC,QAAQ,2FAA2F,CACxI,CAAC;cACF,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;WACpB,CAAC,CAAC;UAEL,MAAM,UAAU,GAAG;;cAEjB,IAAI,KAAK,CAAC,sBAAsB,EAAE;kBAChC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;eAC5C;;cAGD,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,EAAE;kBACzB,eAAe,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;eAC1C;;cAGD,IAAI,OAAO,KAAK,IAAI,EAAE;kBACpB,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;kBAChC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;eACxB;mBAAM;kBACL,KAAK,CAAC,IAAI,EAAE,CAAC;eACd;;cAGD,IAAI,KAAK,CAAC,8BAA8B,EAAE;kBACxC,uBAAuB,EAAE,CAAC;eAC3B;mBAAM,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE;kBACxC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;eAC1D;;cAGD,IAAI,KAAK,CAAC,cAAc,KAAK,IAAI,EAAE;kBACjC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;sBAChC,SAAS,EAAE,CAAC;mBACb,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;eAC1B;cAED,OAAO,EAAE,CAAC;WACX,CAAC;;UAGF,MAAM,SAAS,GAAG;;cAEhB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;;;cAI1C,IAAI,OAAO,KAAK,IAAI,EAAE;kBACpB,KAAK,CAAC,IAAI,EAAE,CAAC;eACd;mBAAM;kBACL,KAAK,CAAC,KAAK,EAAE,CAAC;eACf;cAED,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;cAC9C,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;;cAG5D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,0BAA0B,EAAE,CAAC;;cAGpD,IAAI,UAAU,GAAG;kBACf,EAAE,EAAE,QAAQ,CAAC,EAAE;kBACf,QAAQ,EAAE,KAAK,CAAC,QAAQ;kBACxB,QAAQ,EAAE,QAAQ,CAAC,GAAG;eACvB,CAAC;;cAGF,eAAe,CAAC,SAAS,GAAG,EAAE,CAAC;;cAG/B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;cAErC,cAAc,EAAE,CAAC;WAClB,CAAC;;UAGF,SAAS,cAAc,CAAC,IAAI;;cAE1B,IAAI,QAAQ,CAAC,GAAG,IAAI,IAAI,EAAE;kBACxB,QAAQ,GAAG,IAAI,CAAC;eACjB;cAED,IAAI,KAAK,CAAC,mBAAmB,EAAE;kBAC7B,SAAS,EAAE,CAAC;eACb;WACF;UAED,MAAM,uBAAuB,GAAG;;cAE9B,IAAI,OAAO,KAAK,IAAI,EAAE;kBACpB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC;sBACzC,iBAAiB,EAAE,cAAc;sBACjC,eAAe,EAAE,KAAK,CAAC,OAAO;sBAC9B,SAAS,EAAE,OAAO;sBAClB,OAAO,EAAE,KAAK;sBACd,cAAc,EAAE,KAAK;sBACrB,aAAa,EAAE,OAAO;sBACtB,wBAAwB,EAAE,SAAS;mBACpC,CAAC,CAAC;eACJ;mBAAM;kBACL,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC;sBACzC,iBAAiB,EAAE,cAAc;sBACjC,eAAe,EAAE,KAAK,CAAC,OAAO;sBAC9B,SAAS,EAAE,aAAa;sBACxB,OAAO,EAAE,KAAK;sBACd,cAAc,EAAE,KAAK;mBACtB,CAAC,CAAC;eACJ;WACF,CAAC;UAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO;cACzB,cAAc,GAAG,OAAO,CAAC;WAC1B,CAAC,CAAC;OACJ;;EAvJM,gCAAI,GAAG,IAAI;;;;;;;;"}

package/dist/index.browser.min.js

@@ -0,0 +1,2 @@
+var jsPsychAudioKeyboardResponse=function(e){"use strict";const t={name:"audio-keyboard-response",parameters:{stimulus:{type:e.ParameterType.AUDIO,pretty_name:"Stimulus",default:void 0},choices:{type:e.ParameterType.KEYS,pretty_name:"Choices",default:"ALL_KEYS"},prompt:{type:e.ParameterType.HTML_STRING,pretty_name:"Prompt",default:null},trial_duration:{type:e.ParameterType.INT,pretty_name:"Trial duration",default:null},response_ends_trial:{type:e.ParameterType.BOOL,pretty_name:"Response ends trial",default:!0},trial_ends_after_audio:{type:e.ParameterType.BOOL,pretty_name:"Trial ends after audio",default:!1},response_allowed_while_playing:{type:e.ParameterType.BOOL,pretty_name:"Response allowed while playing",default:!0}}};class s{constructor(e){this.jsPsych=e}trial(e,t,s){let n;var r,a,i=this.jsPsych.pluginAPI.audioContext(),l={rt:null,key:null};this.jsPsych.pluginAPI.getAudioBuffer(t.stimulus).then((function(e){null!==i?((r=i.createBufferSource()).buffer=e,r.connect(i.destination)):(r=e).currentTime=0,o()})).catch((function(e){console.error(`Failed to load audio file "${t.stimulus}". Try checking the file path. We recommend using the preload plugin to load audio files.`),console.error(e)}));const o=()=>{t.trial_ends_after_audio&&r.addEventListener("ended",u),null!==t.prompt&&(e.innerHTML=t.prompt),null!==i?(a=i.currentTime,r.start(a)):r.play(),t.response_allowed_while_playing?p():t.trial_ends_after_audio||r.addEventListener("ended",p),null!==t.trial_duration&&this.jsPsych.pluginAPI.setTimeout((function(){u()}),t.trial_duration),s()},u=()=>{this.jsPsych.pluginAPI.clearAllTimeouts(),null!==i?r.stop():r.pause(),r.removeEventListener("ended",u),r.removeEventListener("ended",p),this.jsPsych.pluginAPI.cancelAllKeyboardResponses();var s={rt:l.rt,stimulus:t.stimulus,response:l.key};e.innerHTML="",this.jsPsych.finishTrial(s),n()};function d(e){null==l.key&&(l=e),t.response_ends_trial&&u()}const p=()=>{null!==i?this.jsPsych.pluginAPI.getKeyboardResponse({callback_function:d,valid_responses:t.choices,rt_method:"audio",persist:!1,allow_held_key:!1,audio_context:i,audio_context_start_time:a}):this.jsPsych.pluginAPI.getKeyboardResponse({callback_function:d,valid_responses:t.choices,rt_method:"performance",persist:!1,allow_held_key:!1})};return new Promise((e=>{n=e}))}}return s.info=t,s}(jsPsychModule);
+//# sourceMappingURL=index.browser.min.js.map

package/dist/index.browser.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.min.js","sources":["../src/index.ts"],"sourcesContent":["import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from \"jspsych\";\n\nconst info = <const>{\n  name: \"audio-keyboard-response\",\n  parameters: {\n    /** The audio file to be played. */\n    stimulus: {\n      type: ParameterType.AUDIO,\n      pretty_name: \"Stimulus\",\n      default: undefined,\n    },\n    /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */\n    choices: {\n      type: ParameterType.KEYS,\n      pretty_name: \"Choices\",\n      default: \"ALL_KEYS\",\n    },\n    /** Any content here will be displayed below the stimulus. */\n    prompt: {\n      type: ParameterType.HTML_STRING,\n      pretty_name: \"Prompt\",\n      default: null,\n    },\n    /** The maximum duration to wait for a response. */\n    trial_duration: {\n      type: ParameterType.INT,\n      pretty_name: \"Trial duration\",\n      default: null,\n    },\n    /** If true, the trial will end when user makes a response. */\n    response_ends_trial: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response ends trial\",\n      default: true,\n    },\n    /** If true, then the trial will end as soon as the audio file finishes playing. */\n    trial_ends_after_audio: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Trial ends after audio\",\n      default: false,\n    },\n    /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */\n    response_allowed_while_playing: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response allowed while playing\",\n      default: true,\n    },\n  },\n};\n\ntype Info = typeof info;\n\n/**\n * **audio-keyboard-response**\n *\n * jsPsych plugin for playing an audio file and getting a keyboard response\n *\n * @author Josh de Leeuw\n * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}\n */\nclass AudioKeyboardResponsePlugin implements JsPsychPlugin<Info> {\n  static info = info;\n\n  constructor(private jsPsych: JsPsych) {}\n\n  trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void) {\n    // hold the .resolve() function from the Promise that ends the trial\n    let trial_complete;\n\n    // setup stimulus\n    var context = this.jsPsych.pluginAPI.audioContext();\n    var audio;\n\n    // store response\n    var response = {\n      rt: null,\n      key: null,\n    };\n\n    // record webaudio context start time\n    var startTime;\n\n    // load audio file\n    this.jsPsych.pluginAPI\n      .getAudioBuffer(trial.stimulus)\n      .then(function (buffer) {\n        if (context !== null) {\n          audio = context.createBufferSource();\n          audio.buffer = buffer;\n          audio.connect(context.destination);\n        } else {\n          audio = buffer;\n          audio.currentTime = 0;\n        }\n        setupTrial();\n      })\n      .catch(function (err) {\n        console.error(\n          `Failed to load audio file \"${trial.stimulus}\". Try checking the file path. We recommend using the preload plugin to load audio files.`\n        );\n        console.error(err);\n      });\n\n    const setupTrial = () => {\n      // set up end event if trial needs it\n      if (trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", end_trial);\n      }\n\n      // show prompt if there is one\n      if (trial.prompt !== null) {\n        display_element.innerHTML = trial.prompt;\n      }\n\n      // start audio\n      if (context !== null) {\n        startTime = context.currentTime;\n        audio.start(startTime);\n      } else {\n        audio.play();\n      }\n\n      // start keyboard listener when trial starts or sound ends\n      if (trial.response_allowed_while_playing) {\n        setup_keyboard_listener();\n      } else if (!trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", setup_keyboard_listener);\n      }\n\n      // end trial if time limit is set\n      if (trial.trial_duration !== null) {\n        this.jsPsych.pluginAPI.setTimeout(function () {\n          end_trial();\n        }, trial.trial_duration);\n      }\n\n      on_load();\n    };\n\n    // function to end trial when it is time\n    const end_trial = () => {\n      // kill any remaining setTimeout handlers\n      this.jsPsych.pluginAPI.clearAllTimeouts();\n\n      // stop the audio file if it is playing\n      // remove end event listeners if they exist\n      if (context !== null) {\n        audio.stop();\n      } else {\n        audio.pause();\n      }\n\n      audio.removeEventListener(\"ended\", end_trial);\n      audio.removeEventListener(\"ended\", setup_keyboard_listener);\n\n      // kill keyboard listeners\n      this.jsPsych.pluginAPI.cancelAllKeyboardResponses();\n\n      // gather the data to store for the trial\n      var trial_data = {\n        rt: response.rt,\n        stimulus: trial.stimulus,\n        response: response.key,\n      };\n\n      // clear the display\n      display_element.innerHTML = \"\";\n\n      // move on to the next trial\n      this.jsPsych.finishTrial(trial_data);\n\n      trial_complete();\n    };\n\n    // function to handle responses by the subject\n    function after_response(info) {\n      // only record the first response\n      if (response.key == null) {\n        response = info;\n      }\n\n      if (trial.response_ends_trial) {\n        end_trial();\n      }\n    }\n\n    const setup_keyboard_listener = () => {\n      // start the response listener\n      if (context !== null) {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"audio\",\n          persist: false,\n          allow_held_key: false,\n          audio_context: context,\n          audio_context_start_time: startTime,\n        });\n      } else {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"performance\",\n          persist: false,\n          allow_held_key: false,\n        });\n      }\n    };\n\n    return new Promise((resolve) => {\n      trial_complete = resolve;\n    });\n  }\n}\n\nexport default AudioKeyboardResponsePlugin;\n"],"names":["info","name","parameters","stimulus","type","ParameterType","AUDIO","pretty_name","default","undefined","choices","KEYS","prompt","HTML_STRING","trial_duration","INT","response_ends_trial","BOOL","trial_ends_after_audio","response_allowed_while_playing","AudioKeyboardResponsePlugin","constructor","jsPsych","this","trial","display_element","on_load","trial_complete","audio","startTime","context","pluginAPI","audioContext","response","rt","key","getAudioBuffer","then","buffer","createBufferSource","connect","destination","currentTime","setupTrial","catch","err","console","error","addEventListener","end_trial","innerHTML","start","play","setup_keyboard_listener","setTimeout","clearAllTimeouts","stop","pause","removeEventListener","cancelAllKeyboardResponses","trial_data","finishTrial","after_response","getKeyboardResponse","callback_function","valid_responses","rt_method","persist","allow_held_key","audio_context","audio_context_start_time","Promise","resolve"],"mappings":"0DAEA,MAAMA,EAAc,CAClBC,KAAM,0BACNC,WAAY,CAEVC,SAAU,CACRC,KAAMC,gBAAcC,MACpBC,YAAa,WACbC,aAASC,GAGXC,QAAS,CACPN,KAAMC,gBAAcM,KACpBJ,YAAa,UACbC,QAAS,YAGXI,OAAQ,CACNR,KAAMC,gBAAcQ,YACpBN,YAAa,SACbC,QAAS,MAGXM,eAAgB,CACdV,KAAMC,gBAAcU,IACpBR,YAAa,iBACbC,QAAS,MAGXQ,oBAAqB,CACnBZ,KAAMC,gBAAcY,KACpBV,YAAa,sBACbC,SAAS,GAGXU,uBAAwB,CACtBd,KAAMC,gBAAcY,KACpBV,YAAa,yBACbC,SAAS,GAGXW,+BAAgC,CAC9Bf,KAAMC,gBAAcY,KACpBV,YAAa,iCACbC,SAAS,KAef,MAAMY,EAGJC,YAAoBC,GAAAC,aAAAD,EAEpBE,MAAMC,EAA8BD,EAAwBE,GAE1D,IAAIC,EAGJ,IACIC,EASAC,EAVAC,EAAUP,KAAKD,QAAQS,UAAUC,eAIjCC,EAAW,CACbC,GAAI,KACJC,IAAK,MAOPZ,KAAKD,QAAQS,UACVK,eAAeZ,EAAMrB,UACrBkC,MAAK,SAAUC,GACE,OAAZR,IACFF,EAAQE,EAAQS,sBACVD,OAASA,EACfV,EAAMY,QAAQV,EAAQW,eAEtBb,EAAQU,GACFI,YAAc,EAEtBC,OAEDC,OAAM,SAAUC,GACfC,QAAQC,MACN,8BAA8BvB,EAAMrB,qGAEtC2C,QAAQC,MAAMF,MAGlB,MAAMF,EAAa,KAEbnB,EAAMN,wBACRU,EAAMoB,iBAAiB,QAASC,GAIb,OAAjBzB,EAAMZ,SACRa,EAAgByB,UAAY1B,EAAMZ,QAIpB,OAAZkB,GACFD,EAAYC,EAAQY,YACpBd,EAAMuB,MAAMtB,IAEZD,EAAMwB,OAIJ5B,EAAML,+BACRkC,IACU7B,EAAMN,wBAChBU,EAAMoB,iBAAiB,QAASK,GAIL,OAAzB7B,EAAMV,gBACRS,KAAKD,QAAQS,UAAUuB,YAAW,WAChCL,MACCzB,EAAMV,gBAGXY,KAIIuB,EAAY,KAEhB1B,KAAKD,QAAQS,UAAUwB,mBAIP,OAAZzB,EACFF,EAAM4B,OAEN5B,EAAM6B,QAGR7B,EAAM8B,oBAAoB,QAAST,GACnCrB,EAAM8B,oBAAoB,QAASL,GAGnC9B,KAAKD,QAAQS,UAAU4B,6BAGvB,IAAIC,EAAa,CACf1B,GAAID,EAASC,GACb/B,SAAUqB,EAAMrB,SAChB8B,SAAUA,EAASE,KAIrBV,EAAgByB,UAAY,GAG5B3B,KAAKD,QAAQuC,YAAYD,GAEzBjC,KAIF,SAASmC,EAAe9D,GAEF,MAAhBiC,EAASE,MACXF,EAAWjC,GAGTwB,EAAMR,qBACRiC,IAIJ,MAAMI,EAA0B,KAEd,OAAZvB,EACFP,KAAKD,QAAQS,UAAUgC,oBAAoB,CACzCC,kBAAmBF,EACnBG,gBAAiBzC,EAAMd,QACvBwD,UAAW,QACXC,SAAS,EACTC,gBAAgB,EAChBC,cAAevC,EACfwC,yBAA0BzC,IAG5BN,KAAKD,QAAQS,UAAUgC,oBAAoB,CACzCC,kBAAmBF,EACnBG,gBAAiBzC,EAAMd,QACvBwD,UAAW,cACXC,SAAS,EACTC,gBAAgB,KAKtB,OAAO,IAAIG,SAASC,IAClB7C,EAAiB6C,aArJdpD,OAAOpB"}

package/dist/index.cjs

@@ -0,0 +1,197 @@
+'use strict';
+
+var jspsych = require('jspsych');
+
+const info = {
+    name: "audio-keyboard-response",
+    parameters: {
+        /** The audio file to be played. */
+        stimulus: {
+            type: jspsych.ParameterType.AUDIO,
+            pretty_name: "Stimulus",
+            default: undefined,
+        },
+        /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */
+        choices: {
+            type: jspsych.ParameterType.KEYS,
+            pretty_name: "Choices",
+            default: "ALL_KEYS",
+        },
+        /** Any content here will be displayed below the stimulus. */
+        prompt: {
+            type: jspsych.ParameterType.HTML_STRING,
+            pretty_name: "Prompt",
+            default: null,
+        },
+        /** The maximum duration to wait for a response. */
+        trial_duration: {
+            type: jspsych.ParameterType.INT,
+            pretty_name: "Trial duration",
+            default: null,
+        },
+        /** If true, the trial will end when user makes a response. */
+        response_ends_trial: {
+            type: jspsych.ParameterType.BOOL,
+            pretty_name: "Response ends trial",
+            default: true,
+        },
+        /** If true, then the trial will end as soon as the audio file finishes playing. */
+        trial_ends_after_audio: {
+            type: jspsych.ParameterType.BOOL,
+            pretty_name: "Trial ends after audio",
+            default: false,
+        },
+        /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */
+        response_allowed_while_playing: {
+            type: jspsych.ParameterType.BOOL,
+            pretty_name: "Response allowed while playing",
+            default: true,
+        },
+    },
+};
+/**
+ * **audio-keyboard-response**
+ *
+ * jsPsych plugin for playing an audio file and getting a keyboard response
+ *
+ * @author Josh de Leeuw
+ * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}
+ */
+class AudioKeyboardResponsePlugin {
+    constructor(jsPsych) {
+        this.jsPsych = jsPsych;
+    }
+    trial(display_element, trial, on_load) {
+        // hold the .resolve() function from the Promise that ends the trial
+        let trial_complete;
+        // setup stimulus
+        var context = this.jsPsych.pluginAPI.audioContext();
+        var audio;
+        // store response
+        var response = {
+            rt: null,
+            key: null,
+        };
+        // record webaudio context start time
+        var startTime;
+        // load audio file
+        this.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);
+        });
+        const 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) {
+                this.jsPsych.pluginAPI.setTimeout(function () {
+                    end_trial();
+                }, trial.trial_duration);
+            }
+            on_load();
+        };
+        // function to end trial when it is time
+        const end_trial = () => {
+            // kill any remaining setTimeout handlers
+            this.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
+            this.jsPsych.pluginAPI.cancelAllKeyboardResponses();
+            // gather the data to store for the trial
+            var trial_data = {
+                rt: response.rt,
+                stimulus: trial.stimulus,
+                response: response.key,
+            };
+            // clear the display
+            display_element.innerHTML = "";
+            // move on to the next trial
+            this.jsPsych.finishTrial(trial_data);
+            trial_complete();
+        };
+        // 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();
+            }
+        }
+        const setup_keyboard_listener = () => {
+            // start the response listener
+            if (context !== null) {
+                this.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 {
+                this.jsPsych.pluginAPI.getKeyboardResponse({
+                    callback_function: after_response,
+                    valid_responses: trial.choices,
+                    rt_method: "performance",
+                    persist: false,
+                    allow_held_key: false,
+                });
+            }
+        };
+        return new Promise((resolve) => {
+            trial_complete = resolve;
+        });
+    }
+}
+AudioKeyboardResponsePlugin.info = info;
+
+module.exports = AudioKeyboardResponsePlugin;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from \"jspsych\";\n\nconst info = <const>{\n  name: \"audio-keyboard-response\",\n  parameters: {\n    /** The audio file to be played. */\n    stimulus: {\n      type: ParameterType.AUDIO,\n      pretty_name: \"Stimulus\",\n      default: undefined,\n    },\n    /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */\n    choices: {\n      type: ParameterType.KEYS,\n      pretty_name: \"Choices\",\n      default: \"ALL_KEYS\",\n    },\n    /** Any content here will be displayed below the stimulus. */\n    prompt: {\n      type: ParameterType.HTML_STRING,\n      pretty_name: \"Prompt\",\n      default: null,\n    },\n    /** The maximum duration to wait for a response. */\n    trial_duration: {\n      type: ParameterType.INT,\n      pretty_name: \"Trial duration\",\n      default: null,\n    },\n    /** If true, the trial will end when user makes a response. */\n    response_ends_trial: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response ends trial\",\n      default: true,\n    },\n    /** If true, then the trial will end as soon as the audio file finishes playing. */\n    trial_ends_after_audio: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Trial ends after audio\",\n      default: false,\n    },\n    /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */\n    response_allowed_while_playing: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response allowed while playing\",\n      default: true,\n    },\n  },\n};\n\ntype Info = typeof info;\n\n/**\n * **audio-keyboard-response**\n *\n * jsPsych plugin for playing an audio file and getting a keyboard response\n *\n * @author Josh de Leeuw\n * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}\n */\nclass AudioKeyboardResponsePlugin implements JsPsychPlugin<Info> {\n  static info = info;\n\n  constructor(private jsPsych: JsPsych) {}\n\n  trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void) {\n    // hold the .resolve() function from the Promise that ends the trial\n    let trial_complete;\n\n    // setup stimulus\n    var context = this.jsPsych.pluginAPI.audioContext();\n    var audio;\n\n    // store response\n    var response = {\n      rt: null,\n      key: null,\n    };\n\n    // record webaudio context start time\n    var startTime;\n\n    // load audio file\n    this.jsPsych.pluginAPI\n      .getAudioBuffer(trial.stimulus)\n      .then(function (buffer) {\n        if (context !== null) {\n          audio = context.createBufferSource();\n          audio.buffer = buffer;\n          audio.connect(context.destination);\n        } else {\n          audio = buffer;\n          audio.currentTime = 0;\n        }\n        setupTrial();\n      })\n      .catch(function (err) {\n        console.error(\n          `Failed to load audio file \"${trial.stimulus}\". Try checking the file path. We recommend using the preload plugin to load audio files.`\n        );\n        console.error(err);\n      });\n\n    const setupTrial = () => {\n      // set up end event if trial needs it\n      if (trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", end_trial);\n      }\n\n      // show prompt if there is one\n      if (trial.prompt !== null) {\n        display_element.innerHTML = trial.prompt;\n      }\n\n      // start audio\n      if (context !== null) {\n        startTime = context.currentTime;\n        audio.start(startTime);\n      } else {\n        audio.play();\n      }\n\n      // start keyboard listener when trial starts or sound ends\n      if (trial.response_allowed_while_playing) {\n        setup_keyboard_listener();\n      } else if (!trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", setup_keyboard_listener);\n      }\n\n      // end trial if time limit is set\n      if (trial.trial_duration !== null) {\n        this.jsPsych.pluginAPI.setTimeout(function () {\n          end_trial();\n        }, trial.trial_duration);\n      }\n\n      on_load();\n    };\n\n    // function to end trial when it is time\n    const end_trial = () => {\n      // kill any remaining setTimeout handlers\n      this.jsPsych.pluginAPI.clearAllTimeouts();\n\n      // stop the audio file if it is playing\n      // remove end event listeners if they exist\n      if (context !== null) {\n        audio.stop();\n      } else {\n        audio.pause();\n      }\n\n      audio.removeEventListener(\"ended\", end_trial);\n      audio.removeEventListener(\"ended\", setup_keyboard_listener);\n\n      // kill keyboard listeners\n      this.jsPsych.pluginAPI.cancelAllKeyboardResponses();\n\n      // gather the data to store for the trial\n      var trial_data = {\n        rt: response.rt,\n        stimulus: trial.stimulus,\n        response: response.key,\n      };\n\n      // clear the display\n      display_element.innerHTML = \"\";\n\n      // move on to the next trial\n      this.jsPsych.finishTrial(trial_data);\n\n      trial_complete();\n    };\n\n    // function to handle responses by the subject\n    function after_response(info) {\n      // only record the first response\n      if (response.key == null) {\n        response = info;\n      }\n\n      if (trial.response_ends_trial) {\n        end_trial();\n      }\n    }\n\n    const setup_keyboard_listener = () => {\n      // start the response listener\n      if (context !== null) {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"audio\",\n          persist: false,\n          allow_held_key: false,\n          audio_context: context,\n          audio_context_start_time: startTime,\n        });\n      } else {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"performance\",\n          persist: false,\n          allow_held_key: false,\n        });\n      }\n    };\n\n    return new Promise((resolve) => {\n      trial_complete = resolve;\n    });\n  }\n}\n\nexport default AudioKeyboardResponsePlugin;\n"],"names":["ParameterType"],"mappings":";;;;AAEA,MAAM,IAAI,GAAU;IAClB,IAAI,EAAE,yBAAyB;IAC/B,UAAU,EAAE;;QAEV,QAAQ,EAAE;YACR,IAAI,EAAEA,qBAAa,CAAC,KAAK;YACzB,WAAW,EAAE,UAAU;YACvB,OAAO,EAAE,SAAS;SACnB;;QAED,OAAO,EAAE;YACP,IAAI,EAAEA,qBAAa,CAAC,IAAI;YACxB,WAAW,EAAE,SAAS;YACtB,OAAO,EAAE,UAAU;SACpB;;QAED,MAAM,EAAE;YACN,IAAI,EAAEA,qBAAa,CAAC,WAAW;YAC/B,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,IAAI;SACd;;QAED,cAAc,EAAE;YACd,IAAI,EAAEA,qBAAa,CAAC,GAAG;YACvB,WAAW,EAAE,gBAAgB;YAC7B,OAAO,EAAE,IAAI;SACd;;QAED,mBAAmB,EAAE;YACnB,IAAI,EAAEA,qBAAa,CAAC,IAAI;YACxB,WAAW,EAAE,qBAAqB;YAClC,OAAO,EAAE,IAAI;SACd;;QAED,sBAAsB,EAAE;YACtB,IAAI,EAAEA,qBAAa,CAAC,IAAI;YACxB,WAAW,EAAE,wBAAwB;YACrC,OAAO,EAAE,KAAK;SACf;;QAED,8BAA8B,EAAE;YAC9B,IAAI,EAAEA,qBAAa,CAAC,IAAI;YACxB,WAAW,EAAE,gCAAgC;YAC7C,OAAO,EAAE,IAAI;SACd;KACF;CACF,CAAC;AAIF;;;;;;;;AAQA,MAAM,2BAA2B;IAG/B,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;KAAI;IAExC,KAAK,CAAC,eAA4B,EAAE,KAAsB,EAAE,OAAmB;;QAE7E,IAAI,cAAc,CAAC;;QAGnB,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;QACpD,IAAI,KAAK,CAAC;;QAGV,IAAI,QAAQ,GAAG;YACb,EAAE,EAAE,IAAI;YACR,GAAG,EAAE,IAAI;SACV,CAAC;;QAGF,IAAI,SAAS,CAAC;;QAGd,IAAI,CAAC,OAAO,CAAC,SAAS;aACnB,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC;aAC9B,IAAI,CAAC,UAAU,MAAM;YACpB,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,KAAK,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;gBACrC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBACtB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;aACpC;iBAAM;gBACL,KAAK,GAAG,MAAM,CAAC;gBACf,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;aACvB;YACD,UAAU,EAAE,CAAC;SACd,CAAC;aACD,KAAK,CAAC,UAAU,GAAG;YAClB,OAAO,CAAC,KAAK,CACX,8BAA8B,KAAK,CAAC,QAAQ,2FAA2F,CACxI,CAAC;YACF,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACpB,CAAC,CAAC;QAEL,MAAM,UAAU,GAAG;;YAEjB,IAAI,KAAK,CAAC,sBAAsB,EAAE;gBAChC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;aAC5C;;YAGD,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,EAAE;gBACzB,eAAe,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;aAC1C;;YAGD,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;gBAChC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;aACxB;iBAAM;gBACL,KAAK,CAAC,IAAI,EAAE,CAAC;aACd;;YAGD,IAAI,KAAK,CAAC,8BAA8B,EAAE;gBACxC,uBAAuB,EAAE,CAAC;aAC3B;iBAAM,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE;gBACxC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;aAC1D;;YAGD,IAAI,KAAK,CAAC,cAAc,KAAK,IAAI,EAAE;gBACjC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;oBAChC,SAAS,EAAE,CAAC;iBACb,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;aAC1B;YAED,OAAO,EAAE,CAAC;SACX,CAAC;;QAGF,MAAM,SAAS,GAAG;;YAEhB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;;;YAI1C,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,KAAK,CAAC,IAAI,EAAE,CAAC;aACd;iBAAM;gBACL,KAAK,CAAC,KAAK,EAAE,CAAC;aACf;YAED,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC9C,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;;YAG5D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,0BAA0B,EAAE,CAAC;;YAGpD,IAAI,UAAU,GAAG;gBACf,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,QAAQ,EAAE,QAAQ,CAAC,GAAG;aACvB,CAAC;;YAGF,eAAe,CAAC,SAAS,GAAG,EAAE,CAAC;;YAG/B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAErC,cAAc,EAAE,CAAC;SAClB,CAAC;;QAGF,SAAS,cAAc,CAAC,IAAI;;YAE1B,IAAI,QAAQ,CAAC,GAAG,IAAI,IAAI,EAAE;gBACxB,QAAQ,GAAG,IAAI,CAAC;aACjB;YAED,IAAI,KAAK,CAAC,mBAAmB,EAAE;gBAC7B,SAAS,EAAE,CAAC;aACb;SACF;QAED,MAAM,uBAAuB,GAAG;;YAE9B,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC;oBACzC,iBAAiB,EAAE,cAAc;oBACjC,eAAe,EAAE,KAAK,CAAC,OAAO;oBAC9B,SAAS,EAAE,OAAO;oBAClB,OAAO,EAAE,KAAK;oBACd,cAAc,EAAE,KAAK;oBACrB,aAAa,EAAE,OAAO;oBACtB,wBAAwB,EAAE,SAAS;iBACpC,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC;oBACzC,iBAAiB,EAAE,cAAc;oBACjC,eAAe,EAAE,KAAK,CAAC,OAAO;oBAC9B,SAAS,EAAE,aAAa;oBACxB,OAAO,EAAE,KAAK;oBACd,cAAc,EAAE,KAAK;iBACtB,CAAC,CAAC;aACJ;SACF,CAAC;QAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO;YACzB,cAAc,GAAG,OAAO,CAAC;SAC1B,CAAC,CAAC;KACJ;;AAvJM,gCAAI,GAAG,IAAI;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
+declare const info: {
+    readonly name: "audio-keyboard-response";
+    readonly parameters: {
+        /** The audio file to be played. */
+        readonly stimulus: {
+            readonly type: ParameterType.AUDIO;
+            readonly pretty_name: "Stimulus";
+            readonly default: any;
+        };
+        /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */
+        readonly choices: {
+            readonly type: ParameterType.KEYS;
+            readonly pretty_name: "Choices";
+            readonly default: "ALL_KEYS";
+        };
+        /** Any content here will be displayed below the stimulus. */
+        readonly prompt: {
+            readonly type: ParameterType.HTML_STRING;
+            readonly pretty_name: "Prompt";
+            readonly default: any;
+        };
+        /** The maximum duration to wait for a response. */
+        readonly trial_duration: {
+            readonly type: ParameterType.INT;
+            readonly pretty_name: "Trial duration";
+            readonly default: any;
+        };
+        /** If true, the trial will end when user makes a response. */
+        readonly response_ends_trial: {
+            readonly type: ParameterType.BOOL;
+            readonly pretty_name: "Response ends trial";
+            readonly default: true;
+        };
+        /** If true, then the trial will end as soon as the audio file finishes playing. */
+        readonly trial_ends_after_audio: {
+            readonly type: ParameterType.BOOL;
+            readonly pretty_name: "Trial ends after audio";
+            readonly default: false;
+        };
+        /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */
+        readonly response_allowed_while_playing: {
+            readonly type: ParameterType.BOOL;
+            readonly pretty_name: "Response allowed while playing";
+            readonly default: true;
+        };
+    };
+};
+declare type Info = typeof info;
+/**
+ * **audio-keyboard-response**
+ *
+ * jsPsych plugin for playing an audio file and getting a keyboard response
+ *
+ * @author Josh de Leeuw
+ * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}
+ */
+declare class AudioKeyboardResponsePlugin implements JsPsychPlugin<Info> {
+    private jsPsych;
+    static info: {
+        readonly name: "audio-keyboard-response";
+        readonly parameters: {
+            /** The audio file to be played. */
+            readonly stimulus: {
+                readonly type: ParameterType.AUDIO;
+                readonly pretty_name: "Stimulus";
+                readonly default: any;
+            };
+            /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */
+            readonly choices: {
+                readonly type: ParameterType.KEYS;
+                readonly pretty_name: "Choices";
+                readonly default: "ALL_KEYS";
+            };
+            /** Any content here will be displayed below the stimulus. */
+            readonly prompt: {
+                readonly type: ParameterType.HTML_STRING;
+                readonly pretty_name: "Prompt";
+                readonly default: any;
+            };
+            /** The maximum duration to wait for a response. */
+            readonly trial_duration: {
+                readonly type: ParameterType.INT;
+                readonly pretty_name: "Trial duration";
+                readonly default: any;
+            };
+            /** If true, the trial will end when user makes a response. */
+            readonly response_ends_trial: {
+                readonly type: ParameterType.BOOL;
+                readonly pretty_name: "Response ends trial";
+                readonly default: true;
+            };
+            /** If true, then the trial will end as soon as the audio file finishes playing. */
+            readonly trial_ends_after_audio: {
+                readonly type: ParameterType.BOOL;
+                readonly pretty_name: "Trial ends after audio";
+                readonly default: false;
+            };
+            /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */
+            readonly response_allowed_while_playing: {
+                readonly type: ParameterType.BOOL;
+                readonly pretty_name: "Response allowed while playing";
+                readonly default: true;
+            };
+        };
+    };
+    constructor(jsPsych: JsPsych);
+    trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void): Promise<unknown>;
+}
+export default AudioKeyboardResponsePlugin;

package/dist/index.js

@@ -0,0 +1,195 @@
+import { ParameterType } from 'jspsych';
+
+const info = {
+    name: "audio-keyboard-response",
+    parameters: {
+        /** The audio file to be played. */
+        stimulus: {
+            type: ParameterType.AUDIO,
+            pretty_name: "Stimulus",
+            default: undefined,
+        },
+        /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */
+        choices: {
+            type: ParameterType.KEYS,
+            pretty_name: "Choices",
+            default: "ALL_KEYS",
+        },
+        /** Any content here will be displayed below the stimulus. */
+        prompt: {
+            type: ParameterType.HTML_STRING,
+            pretty_name: "Prompt",
+            default: null,
+        },
+        /** The maximum duration to wait for a response. */
+        trial_duration: {
+            type: ParameterType.INT,
+            pretty_name: "Trial duration",
+            default: null,
+        },
+        /** If true, the trial will end when user makes a response. */
+        response_ends_trial: {
+            type: ParameterType.BOOL,
+            pretty_name: "Response ends trial",
+            default: true,
+        },
+        /** If true, then the trial will end as soon as the audio file finishes playing. */
+        trial_ends_after_audio: {
+            type: ParameterType.BOOL,
+            pretty_name: "Trial ends after audio",
+            default: false,
+        },
+        /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */
+        response_allowed_while_playing: {
+            type: ParameterType.BOOL,
+            pretty_name: "Response allowed while playing",
+            default: true,
+        },
+    },
+};
+/**
+ * **audio-keyboard-response**
+ *
+ * jsPsych plugin for playing an audio file and getting a keyboard response
+ *
+ * @author Josh de Leeuw
+ * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}
+ */
+class AudioKeyboardResponsePlugin {
+    constructor(jsPsych) {
+        this.jsPsych = jsPsych;
+    }
+    trial(display_element, trial, on_load) {
+        // hold the .resolve() function from the Promise that ends the trial
+        let trial_complete;
+        // setup stimulus
+        var context = this.jsPsych.pluginAPI.audioContext();
+        var audio;
+        // store response
+        var response = {
+            rt: null,
+            key: null,
+        };
+        // record webaudio context start time
+        var startTime;
+        // load audio file
+        this.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);
+        });
+        const 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) {
+                this.jsPsych.pluginAPI.setTimeout(function () {
+                    end_trial();
+                }, trial.trial_duration);
+            }
+            on_load();
+        };
+        // function to end trial when it is time
+        const end_trial = () => {
+            // kill any remaining setTimeout handlers
+            this.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
+            this.jsPsych.pluginAPI.cancelAllKeyboardResponses();
+            // gather the data to store for the trial
+            var trial_data = {
+                rt: response.rt,
+                stimulus: trial.stimulus,
+                response: response.key,
+            };
+            // clear the display
+            display_element.innerHTML = "";
+            // move on to the next trial
+            this.jsPsych.finishTrial(trial_data);
+            trial_complete();
+        };
+        // 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();
+            }
+        }
+        const setup_keyboard_listener = () => {
+            // start the response listener
+            if (context !== null) {
+                this.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 {
+                this.jsPsych.pluginAPI.getKeyboardResponse({
+                    callback_function: after_response,
+                    valid_responses: trial.choices,
+                    rt_method: "performance",
+                    persist: false,
+                    allow_held_key: false,
+                });
+            }
+        };
+        return new Promise((resolve) => {
+            trial_complete = resolve;
+        });
+    }
+}
+AudioKeyboardResponsePlugin.info = info;
+
+export { AudioKeyboardResponsePlugin as default };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from \"jspsych\";\n\nconst info = <const>{\n  name: \"audio-keyboard-response\",\n  parameters: {\n    /** The audio file to be played. */\n    stimulus: {\n      type: ParameterType.AUDIO,\n      pretty_name: \"Stimulus\",\n      default: undefined,\n    },\n    /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */\n    choices: {\n      type: ParameterType.KEYS,\n      pretty_name: \"Choices\",\n      default: \"ALL_KEYS\",\n    },\n    /** Any content here will be displayed below the stimulus. */\n    prompt: {\n      type: ParameterType.HTML_STRING,\n      pretty_name: \"Prompt\",\n      default: null,\n    },\n    /** The maximum duration to wait for a response. */\n    trial_duration: {\n      type: ParameterType.INT,\n      pretty_name: \"Trial duration\",\n      default: null,\n    },\n    /** If true, the trial will end when user makes a response. */\n    response_ends_trial: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response ends trial\",\n      default: true,\n    },\n    /** If true, then the trial will end as soon as the audio file finishes playing. */\n    trial_ends_after_audio: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Trial ends after audio\",\n      default: false,\n    },\n    /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */\n    response_allowed_while_playing: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response allowed while playing\",\n      default: true,\n    },\n  },\n};\n\ntype Info = typeof info;\n\n/**\n * **audio-keyboard-response**\n *\n * jsPsych plugin for playing an audio file and getting a keyboard response\n *\n * @author Josh de Leeuw\n * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}\n */\nclass AudioKeyboardResponsePlugin implements JsPsychPlugin<Info> {\n  static info = info;\n\n  constructor(private jsPsych: JsPsych) {}\n\n  trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void) {\n    // hold the .resolve() function from the Promise that ends the trial\n    let trial_complete;\n\n    // setup stimulus\n    var context = this.jsPsych.pluginAPI.audioContext();\n    var audio;\n\n    // store response\n    var response = {\n      rt: null,\n      key: null,\n    };\n\n    // record webaudio context start time\n    var startTime;\n\n    // load audio file\n    this.jsPsych.pluginAPI\n      .getAudioBuffer(trial.stimulus)\n      .then(function (buffer) {\n        if (context !== null) {\n          audio = context.createBufferSource();\n          audio.buffer = buffer;\n          audio.connect(context.destination);\n        } else {\n          audio = buffer;\n          audio.currentTime = 0;\n        }\n        setupTrial();\n      })\n      .catch(function (err) {\n        console.error(\n          `Failed to load audio file \"${trial.stimulus}\". Try checking the file path. We recommend using the preload plugin to load audio files.`\n        );\n        console.error(err);\n      });\n\n    const setupTrial = () => {\n      // set up end event if trial needs it\n      if (trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", end_trial);\n      }\n\n      // show prompt if there is one\n      if (trial.prompt !== null) {\n        display_element.innerHTML = trial.prompt;\n      }\n\n      // start audio\n      if (context !== null) {\n        startTime = context.currentTime;\n        audio.start(startTime);\n      } else {\n        audio.play();\n      }\n\n      // start keyboard listener when trial starts or sound ends\n      if (trial.response_allowed_while_playing) {\n        setup_keyboard_listener();\n      } else if (!trial.trial_ends_after_audio) {\n        audio.addEventListener(\"ended\", setup_keyboard_listener);\n      }\n\n      // end trial if time limit is set\n      if (trial.trial_duration !== null) {\n        this.jsPsych.pluginAPI.setTimeout(function () {\n          end_trial();\n        }, trial.trial_duration);\n      }\n\n      on_load();\n    };\n\n    // function to end trial when it is time\n    const end_trial = () => {\n      // kill any remaining setTimeout handlers\n      this.jsPsych.pluginAPI.clearAllTimeouts();\n\n      // stop the audio file if it is playing\n      // remove end event listeners if they exist\n      if (context !== null) {\n        audio.stop();\n      } else {\n        audio.pause();\n      }\n\n      audio.removeEventListener(\"ended\", end_trial);\n      audio.removeEventListener(\"ended\", setup_keyboard_listener);\n\n      // kill keyboard listeners\n      this.jsPsych.pluginAPI.cancelAllKeyboardResponses();\n\n      // gather the data to store for the trial\n      var trial_data = {\n        rt: response.rt,\n        stimulus: trial.stimulus,\n        response: response.key,\n      };\n\n      // clear the display\n      display_element.innerHTML = \"\";\n\n      // move on to the next trial\n      this.jsPsych.finishTrial(trial_data);\n\n      trial_complete();\n    };\n\n    // function to handle responses by the subject\n    function after_response(info) {\n      // only record the first response\n      if (response.key == null) {\n        response = info;\n      }\n\n      if (trial.response_ends_trial) {\n        end_trial();\n      }\n    }\n\n    const setup_keyboard_listener = () => {\n      // start the response listener\n      if (context !== null) {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"audio\",\n          persist: false,\n          allow_held_key: false,\n          audio_context: context,\n          audio_context_start_time: startTime,\n        });\n      } else {\n        this.jsPsych.pluginAPI.getKeyboardResponse({\n          callback_function: after_response,\n          valid_responses: trial.choices,\n          rt_method: \"performance\",\n          persist: false,\n          allow_held_key: false,\n        });\n      }\n    };\n\n    return new Promise((resolve) => {\n      trial_complete = resolve;\n    });\n  }\n}\n\nexport default AudioKeyboardResponsePlugin;\n"],"names":[],"mappings":";;AAEA,MAAM,IAAI,GAAU;IAClB,IAAI,EAAE,yBAAyB;IAC/B,UAAU,EAAE;;QAEV,QAAQ,EAAE;YACR,IAAI,EAAE,aAAa,CAAC,KAAK;YACzB,WAAW,EAAE,UAAU;YACvB,OAAO,EAAE,SAAS;SACnB;;QAED,OAAO,EAAE;YACP,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,WAAW,EAAE,SAAS;YACtB,OAAO,EAAE,UAAU;SACpB;;QAED,MAAM,EAAE;YACN,IAAI,EAAE,aAAa,CAAC,WAAW;YAC/B,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,IAAI;SACd;;QAED,cAAc,EAAE;YACd,IAAI,EAAE,aAAa,CAAC,GAAG;YACvB,WAAW,EAAE,gBAAgB;YAC7B,OAAO,EAAE,IAAI;SACd;;QAED,mBAAmB,EAAE;YACnB,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,WAAW,EAAE,qBAAqB;YAClC,OAAO,EAAE,IAAI;SACd;;QAED,sBAAsB,EAAE;YACtB,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,WAAW,EAAE,wBAAwB;YACrC,OAAO,EAAE,KAAK;SACf;;QAED,8BAA8B,EAAE;YAC9B,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,WAAW,EAAE,gCAAgC;YAC7C,OAAO,EAAE,IAAI;SACd;KACF;CACF,CAAC;AAIF;;;;;;;;AAQA,MAAM,2BAA2B;IAG/B,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;KAAI;IAExC,KAAK,CAAC,eAA4B,EAAE,KAAsB,EAAE,OAAmB;;QAE7E,IAAI,cAAc,CAAC;;QAGnB,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;QACpD,IAAI,KAAK,CAAC;;QAGV,IAAI,QAAQ,GAAG;YACb,EAAE,EAAE,IAAI;YACR,GAAG,EAAE,IAAI;SACV,CAAC;;QAGF,IAAI,SAAS,CAAC;;QAGd,IAAI,CAAC,OAAO,CAAC,SAAS;aACnB,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC;aAC9B,IAAI,CAAC,UAAU,MAAM;YACpB,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,KAAK,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;gBACrC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBACtB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;aACpC;iBAAM;gBACL,KAAK,GAAG,MAAM,CAAC;gBACf,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;aACvB;YACD,UAAU,EAAE,CAAC;SACd,CAAC;aACD,KAAK,CAAC,UAAU,GAAG;YAClB,OAAO,CAAC,KAAK,CACX,8BAA8B,KAAK,CAAC,QAAQ,2FAA2F,CACxI,CAAC;YACF,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACpB,CAAC,CAAC;QAEL,MAAM,UAAU,GAAG;;YAEjB,IAAI,KAAK,CAAC,sBAAsB,EAAE;gBAChC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;aAC5C;;YAGD,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,EAAE;gBACzB,eAAe,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;aAC1C;;YAGD,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;gBAChC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;aACxB;iBAAM;gBACL,KAAK,CAAC,IAAI,EAAE,CAAC;aACd;;YAGD,IAAI,KAAK,CAAC,8BAA8B,EAAE;gBACxC,uBAAuB,EAAE,CAAC;aAC3B;iBAAM,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE;gBACxC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;aAC1D;;YAGD,IAAI,KAAK,CAAC,cAAc,KAAK,IAAI,EAAE;gBACjC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;oBAChC,SAAS,EAAE,CAAC;iBACb,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;aAC1B;YAED,OAAO,EAAE,CAAC;SACX,CAAC;;QAGF,MAAM,SAAS,GAAG;;YAEhB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;;;YAI1C,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,KAAK,CAAC,IAAI,EAAE,CAAC;aACd;iBAAM;gBACL,KAAK,CAAC,KAAK,EAAE,CAAC;aACf;YAED,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC9C,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;;YAG5D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,0BAA0B,EAAE,CAAC;;YAGpD,IAAI,UAAU,GAAG;gBACf,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,QAAQ,EAAE,QAAQ,CAAC,GAAG;aACvB,CAAC;;YAGF,eAAe,CAAC,SAAS,GAAG,EAAE,CAAC;;YAG/B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAErC,cAAc,EAAE,CAAC;SAClB,CAAC;;QAGF,SAAS,cAAc,CAAC,IAAI;;YAE1B,IAAI,QAAQ,CAAC,GAAG,IAAI,IAAI,EAAE;gBACxB,QAAQ,GAAG,IAAI,CAAC;aACjB;YAED,IAAI,KAAK,CAAC,mBAAmB,EAAE;gBAC7B,SAAS,EAAE,CAAC;aACb;SACF;QAED,MAAM,uBAAuB,GAAG;;YAE9B,IAAI,OAAO,KAAK,IAAI,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC;oBACzC,iBAAiB,EAAE,cAAc;oBACjC,eAAe,EAAE,KAAK,CAAC,OAAO;oBAC9B,SAAS,EAAE,OAAO;oBAClB,OAAO,EAAE,KAAK;oBACd,cAAc,EAAE,KAAK;oBACrB,aAAa,EAAE,OAAO;oBACtB,wBAAwB,EAAE,SAAS;iBACpC,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC;oBACzC,iBAAiB,EAAE,cAAc;oBACjC,eAAe,EAAE,KAAK,CAAC,OAAO;oBAC9B,SAAS,EAAE,aAAa;oBACxB,OAAO,EAAE,KAAK;oBACd,cAAc,EAAE,KAAK;iBACtB,CAAC,CAAC;aACJ;SACF,CAAC;QAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO;YACzB,cAAc,GAAG,OAAO,CAAC;SAC1B,CAAC,CAAC;KACJ;;AAvJM,gCAAI,GAAG,IAAI;;;;"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@jspsych/plugin-audio-keyboard-response",
+  "version": "1.0.0",
+  "description": "jsPsych plugin for playing an audio file and getting a keyboard response",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "typings": "dist/index.d.ts",
+  "unpkg": "dist/index.browser.min.js",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "source": "src/index.ts",
+  "scripts": {
+    "test": "jest  --passWithNoTests",
+    "test:watch": "npm test -- --watch",
+    "tsc": "tsc",
+    "build": "rollup --config",
+    "build:watch": "npm run build -- --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jspsych/jsPsych.git",
+    "directory": "packages/plugin-audio-keyboard-response"
+  },
+  "author": "Josh de Leeuw",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jspsych/jsPsych/issues"
+  },
+  "homepage": "https://www.jspsych.org/latest/plugins/audio-keyboard-response",
+  "peerDependencies": {
+    "jspsych": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@jspsych/config": "^1.0.0",
+    "@jspsych/test-utils": "^1.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,216 @@
+import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
+
+const info = <const>{
+  name: "audio-keyboard-response",
+  parameters: {
+    /** The audio file to be played. */
+    stimulus: {
+      type: ParameterType.AUDIO,
+      pretty_name: "Stimulus",
+      default: undefined,
+    },
+    /** Array containing the key(s) the subject is allowed to press to respond to the stimulus. */
+    choices: {
+      type: ParameterType.KEYS,
+      pretty_name: "Choices",
+      default: "ALL_KEYS",
+    },
+    /** Any content here will be displayed below the stimulus. */
+    prompt: {
+      type: ParameterType.HTML_STRING,
+      pretty_name: "Prompt",
+      default: null,
+    },
+    /** The maximum duration to wait for a response. */
+    trial_duration: {
+      type: ParameterType.INT,
+      pretty_name: "Trial duration",
+      default: null,
+    },
+    /** If true, the trial will end when user makes a response. */
+    response_ends_trial: {
+      type: ParameterType.BOOL,
+      pretty_name: "Response ends trial",
+      default: true,
+    },
+    /** If true, then the trial will end as soon as the audio file finishes playing. */
+    trial_ends_after_audio: {
+      type: ParameterType.BOOL,
+      pretty_name: "Trial ends after audio",
+      default: false,
+    },
+    /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */
+    response_allowed_while_playing: {
+      type: ParameterType.BOOL,
+      pretty_name: "Response allowed while playing",
+      default: true,
+    },
+  },
+};
+
+type Info = typeof info;
+
+/**
+ * **audio-keyboard-response**
+ *
+ * jsPsych plugin for playing an audio file and getting a keyboard response
+ *
+ * @author Josh de Leeuw
+ * @see {@link https://www.jspsych.org/plugins/jspsych-audio-keyboard-response/ audio-keyboard-response plugin documentation on jspsych.org}
+ */
+class AudioKeyboardResponsePlugin implements JsPsychPlugin<Info> {
+  static info = info;
+
+  constructor(private jsPsych: JsPsych) {}
+
+  trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void) {
+    // hold the .resolve() function from the Promise that ends the trial
+    let trial_complete;
+
+    // setup stimulus
+    var context = this.jsPsych.pluginAPI.audioContext();
+    var audio;
+
+    // store response
+    var response = {
+      rt: null,
+      key: null,
+    };
+
+    // record webaudio context start time
+    var startTime;
+
+    // load audio file
+    this.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);
+      });
+
+    const 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) {
+        this.jsPsych.pluginAPI.setTimeout(function () {
+          end_trial();
+        }, trial.trial_duration);
+      }
+
+      on_load();
+    };
+
+    // function to end trial when it is time
+    const end_trial = () => {
+      // kill any remaining setTimeout handlers
+      this.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
+      this.jsPsych.pluginAPI.cancelAllKeyboardResponses();
+
+      // gather the data to store for the trial
+      var trial_data = {
+        rt: response.rt,
+        stimulus: trial.stimulus,
+        response: response.key,
+      };
+
+      // clear the display
+      display_element.innerHTML = "";
+
+      // move on to the next trial
+      this.jsPsych.finishTrial(trial_data);
+
+      trial_complete();
+    };
+
+    // 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();
+      }
+    }
+
+    const setup_keyboard_listener = () => {
+      // start the response listener
+      if (context !== null) {
+        this.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 {
+        this.jsPsych.pluginAPI.getKeyboardResponse({
+          callback_function: after_response,
+          valid_responses: trial.choices,
+          rt_method: "performance",
+          persist: false,
+          allow_held_key: false,
+        });
+      }
+    };
+
+    return new Promise((resolve) => {
+      trial_complete = resolve;
+    });
+  }
+}
+
+export default AudioKeyboardResponsePlugin;