@jspsych/plugin-audio-button-response 1.2.0 → 2.0.0

package/dist/index.cjs.map

@@ -1 +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-button-response\",\n  parameters: {\n    /** The audio to be played. */\n    stimulus: {\n      type: ParameterType.AUDIO,\n      pretty_name: \"Stimulus\",\n      default: undefined,\n    },\n    /** Array containing the label(s) for the button(s). */\n    choices: {\n      type: ParameterType.STRING,\n      pretty_name: \"Choices\",\n      default: undefined,\n      array: true,\n    },\n    /** The HTML for creating button. Can create own style. Use the \"%choice%\" string to indicate where the label from the choices parameter should be inserted. */\n    button_html: {\n      type: ParameterType.HTML_STRING,\n      pretty_name: \"Button HTML\",\n      default: '<button class=\"jspsych-btn\">%choice%</button>',\n      array: true,\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    /** Vertical margin of button. */\n    margin_vertical: {\n      type: ParameterType.STRING,\n      pretty_name: \"Margin vertical\",\n      default: \"0px\",\n    },\n    /** Horizontal margin of button. */\n    margin_horizontal: {\n      type: ParameterType.STRING,\n      pretty_name: \"Margin horizontal\",\n      default: \"8px\",\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    /**\n     * If true, then responses are allowed while the audio is playing.\n     * If false, then the audio must finish playing before a response is accepted.\n     */\n    response_allowed_while_playing: {\n      type: ParameterType.BOOL,\n      pretty_name: \"Response allowed while playing\",\n      default: true,\n    },\n    /** The delay of enabling button */\n    enable_button_after: {\n      type: ParameterType.INT,\n      pretty_name: \"Enable button after\",\n      default: 0,\n    },\n  },\n};\n\ntype Info = typeof info;\n\n/**\n * **audio-button-response**\n *\n * jsPsych plugin for playing an audio file and getting a button response\n *\n * @author Kristin Diep\n * @see {@link https://www.jspsych.org/plugins/jspsych-audio-button-response/ audio-button-response plugin documentation on jspsych.org}\n */\nclass AudioButtonResponsePlugin implements JsPsychPlugin<Info> {\n  static info = info;\n  private audio;\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\n    // store response\n    var response = {\n      rt: null,\n      button: 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((buffer) => {\n        if (context !== null) {\n          this.audio = context.createBufferSource();\n          this.audio.buffer = buffer;\n          this.audio.connect(context.destination);\n        } else {\n          this.audio = buffer;\n          this.audio.currentTime = 0;\n        }\n        setupTrial();\n      })\n      .catch((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        this.audio.addEventListener(\"ended\", end_trial);\n      }\n\n      // enable buttons after audio ends if necessary\n      if (!trial.response_allowed_while_playing && !trial.trial_ends_after_audio) {\n        this.audio.addEventListener(\"ended\", enable_buttons);\n      }\n\n      //display buttons\n      var buttons = [];\n      if (Array.isArray(trial.button_html)) {\n        if (trial.button_html.length == trial.choices.length) {\n          buttons = trial.button_html;\n        } else {\n          console.error(\n            \"Error in audio-button-response plugin. The length of the button_html array does not equal the length of the choices array\"\n          );\n        }\n      } else {\n        for (var i = 0; i < trial.choices.length; i++) {\n          buttons.push(trial.button_html);\n        }\n      }\n\n      var html = '<div id=\"jspsych-audio-button-response-btngroup\">';\n      for (var i = 0; i < trial.choices.length; i++) {\n        var str = buttons[i].replace(/%choice%/g, trial.choices[i]);\n        html +=\n          '<div class=\"jspsych-audio-button-response-button\" style=\"cursor: pointer; display: inline-block; margin:' +\n          trial.margin_vertical +\n          \" \" +\n          trial.margin_horizontal +\n          '\" id=\"jspsych-audio-button-response-button-' +\n          i +\n          '\" data-choice=\"' +\n          i +\n          '\">' +\n          str +\n          \"</div>\";\n      }\n      html += \"</div>\";\n\n      //show prompt if there is one\n      if (trial.prompt !== null) {\n        html += trial.prompt;\n      }\n\n      display_element.innerHTML = html;\n\n      if (trial.response_allowed_while_playing) {\n        disable_buttons();\n        enable_buttons();\n      } else {\n        disable_buttons();\n      }\n\n      // start time\n      startTime = performance.now();\n\n      // start audio\n      if (context !== null) {\n        startTime = context.currentTime;\n        this.audio.start(startTime);\n      } else {\n        this.audio.play();\n      }\n\n      // end trial if time limit is set\n      if (trial.trial_duration !== null) {\n        this.jsPsych.pluginAPI.setTimeout(() => {\n          end_trial();\n        }, trial.trial_duration);\n      }\n\n      on_load();\n    };\n\n    // function to handle responses by the subject\n    function after_response(choice) {\n      // measure rt\n      var endTime = performance.now();\n      var rt = Math.round(endTime - startTime);\n      if (context !== null) {\n        endTime = context.currentTime;\n        rt = Math.round((endTime - startTime) * 1000);\n      }\n      response.button = parseInt(choice);\n      response.rt = rt;\n\n      // disable all the buttons after a response\n      disable_buttons();\n\n      if (trial.response_ends_trial) {\n        end_trial();\n      }\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        this.audio.stop();\n      } else {\n        this.audio.pause();\n      }\n\n      this.audio.removeEventListener(\"ended\", end_trial);\n      this.audio.removeEventListener(\"ended\", enable_buttons);\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.button,\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    const enable_buttons_with_delay = (delay: number) => {\n      this.jsPsych.pluginAPI.setTimeout(enable_buttons_without_delay, delay);\n    };\n\n    function button_response(e) {\n      var choice = e.currentTarget.getAttribute(\"data-choice\"); // don't use dataset for jsdom compatibility\n      after_response(choice);\n    }\n\n    function disable_buttons() {\n      var btns = document.querySelectorAll(\".jspsych-audio-button-response-button\");\n      for (var i = 0; i < btns.length; i++) {\n        var btn_el = btns[i].querySelector(\"button\");\n        if (btn_el) {\n          btn_el.disabled = true;\n        }\n        btns[i].removeEventListener(\"click\", button_response);\n      }\n    }\n\n    function enable_buttons_without_delay() {\n      var btns = document.querySelectorAll(\".jspsych-audio-button-response-button\");\n      for (var i = 0; i < btns.length; i++) {\n        var btn_el = btns[i].querySelector(\"button\");\n        if (btn_el) {\n          btn_el.disabled = false;\n        }\n        btns[i].addEventListener(\"click\", button_response);\n      }\n    }\n\n    function enable_buttons() {\n      if (trial.enable_button_after > 0) {\n        enable_buttons_with_delay(trial.enable_button_after);\n      } else {\n        enable_buttons_without_delay();\n      }\n    }\n\n    return new Promise((resolve) => {\n      trial_complete = resolve;\n    });\n  }\n\n  simulate(\n    trial: TrialType<Info>,\n    simulation_mode,\n    simulation_options: any,\n    load_callback: () => void\n  ) {\n    if (simulation_mode == \"data-only\") {\n      load_callback();\n      this.simulate_data_only(trial, simulation_options);\n    }\n    if (simulation_mode == \"visual\") {\n      this.simulate_visual(trial, simulation_options, load_callback);\n    }\n  }\n\n  private create_simulation_data(trial: TrialType<Info>, simulation_options) {\n    const default_data = {\n      stimulus: trial.stimulus,\n      rt:\n        this.jsPsych.randomization.sampleExGaussian(500, 50, 1 / 150, true) +\n        trial.enable_button_after,\n      response: this.jsPsych.randomization.randomInt(0, trial.choices.length - 1),\n    };\n\n    const data = this.jsPsych.pluginAPI.mergeSimulationData(default_data, simulation_options);\n\n    this.jsPsych.pluginAPI.ensureSimulationDataConsistency(trial, data);\n\n    return data;\n  }\n\n  private simulate_data_only(trial: TrialType<Info>, simulation_options) {\n    const data = this.create_simulation_data(trial, simulation_options);\n\n    this.jsPsych.finishTrial(data);\n  }\n\n  private simulate_visual(trial: TrialType<Info>, simulation_options, load_callback: () => void) {\n    const data = this.create_simulation_data(trial, simulation_options);\n\n    const display_element = this.jsPsych.getDisplayElement();\n\n    const respond = () => {\n      if (data.rt !== null) {\n        this.jsPsych.pluginAPI.clickTarget(\n          display_element.querySelector(`div[data-choice=\"${data.response}\"] button`),\n          data.rt\n        );\n      }\n    };\n\n    this.trial(display_element, trial, () => {\n      load_callback();\n      if (!trial.response_allowed_while_playing) {\n        this.audio.addEventListener(\"ended\", respond);\n      } else {\n        respond();\n      }\n    });\n  }\n}\n\nexport default AudioButtonResponsePlugin;\n"],"names":["ParameterType"],"mappings":";;;;AAEA,MAAM,IAAI,GAAU;AAClB,IAAA,IAAI,EAAE,uBAAuB;AAC7B,IAAA,UAAU,EAAE;;AAEV,QAAA,QAAQ,EAAE;YACR,IAAI,EAAEA,qBAAa,CAAC,KAAK;AACzB,YAAA,WAAW,EAAE,UAAU;AACvB,YAAA,OAAO,EAAE,SAAS;AACnB,SAAA;;AAED,QAAA,OAAO,EAAE;YACP,IAAI,EAAEA,qBAAa,CAAC,MAAM;AAC1B,YAAA,WAAW,EAAE,SAAS;AACtB,YAAA,OAAO,EAAE,SAAS;AAClB,YAAA,KAAK,EAAE,IAAI;AACZ,SAAA;;AAED,QAAA,WAAW,EAAE;YACX,IAAI,EAAEA,qBAAa,CAAC,WAAW;AAC/B,YAAA,WAAW,EAAE,aAAa;AAC1B,YAAA,OAAO,EAAE,+CAA+C;AACxD,YAAA,KAAK,EAAE,IAAI;AACZ,SAAA;;AAED,QAAA,MAAM,EAAE;YACN,IAAI,EAAEA,qBAAa,CAAC,WAAW;AAC/B,YAAA,WAAW,EAAE,QAAQ;AACrB,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;;AAED,QAAA,cAAc,EAAE;YACd,IAAI,EAAEA,qBAAa,CAAC,GAAG;AACvB,YAAA,WAAW,EAAE,gBAAgB;AAC7B,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;;AAED,QAAA,eAAe,EAAE;YACf,IAAI,EAAEA,qBAAa,CAAC,MAAM;AAC1B,YAAA,WAAW,EAAE,iBAAiB;AAC9B,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;;AAED,QAAA,iBAAiB,EAAE;YACjB,IAAI,EAAEA,qBAAa,CAAC,MAAM;AAC1B,YAAA,WAAW,EAAE,mBAAmB;AAChC,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;;AAED,QAAA,mBAAmB,EAAE;YACnB,IAAI,EAAEA,qBAAa,CAAC,IAAI;AACxB,YAAA,WAAW,EAAE,qBAAqB;AAClC,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;;AAED,QAAA,sBAAsB,EAAE;YACtB,IAAI,EAAEA,qBAAa,CAAC,IAAI;AACxB,YAAA,WAAW,EAAE,wBAAwB;AACrC,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;AACD;;;AAGG;AACH,QAAA,8BAA8B,EAAE;YAC9B,IAAI,EAAEA,qBAAa,CAAC,IAAI;AACxB,YAAA,WAAW,EAAE,gCAAgC;AAC7C,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;;AAED,QAAA,mBAAmB,EAAE;YACnB,IAAI,EAAEA,qBAAa,CAAC,GAAG;AACvB,YAAA,WAAW,EAAE,qBAAqB;AAClC,YAAA,OAAO,EAAE,CAAC;AACX,SAAA;AACF,KAAA;CACF,CAAC;AAIF;;;;;;;AAOG;AACH,MAAM,yBAAyB,CAAA;AAI7B,IAAA,WAAA,CAAoB,OAAgB,EAAA;QAAhB,IAAO,CAAA,OAAA,GAAP,OAAO,CAAS;KAAI;AAExC,IAAA,KAAK,CAAC,eAA4B,EAAE,KAAsB,EAAE,OAAmB,EAAA;;AAE7E,QAAA,IAAI,cAAc,CAAC;;QAGnB,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;;AAGpD,QAAA,IAAI,QAAQ,GAAG;AACb,YAAA,EAAE,EAAE,IAAI;AACR,YAAA,MAAM,EAAE,IAAI;SACb,CAAC;;AAGF,QAAA,IAAI,SAAS,CAAC;;QAGd,IAAI,CAAC,OAAO,CAAC,SAAS;AACnB,aAAA,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC;AAC9B,aAAA,IAAI,CAAC,CAAC,MAAM,KAAI;YACf,IAAI,OAAO,KAAK,IAAI,EAAE;AACpB,gBAAA,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;AAC1C,gBAAA,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;AACzC,aAAA;AAAM,iBAAA;AACL,gBAAA,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;AACpB,gBAAA,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;AAC5B,aAAA;AACD,YAAA,UAAU,EAAE,CAAC;AACf,SAAC,CAAC;AACD,aAAA,KAAK,CAAC,CAAC,GAAG,KAAI;YACb,OAAO,CAAC,KAAK,CACX,CAAA,2BAAA,EAA8B,KAAK,CAAC,QAAQ,CAA2F,yFAAA,CAAA,CACxI,CAAC;AACF,YAAA,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACrB,SAAC,CAAC,CAAC;QAEL,MAAM,UAAU,GAAG,MAAK;;YAEtB,IAAI,KAAK,CAAC,sBAAsB,EAAE;gBAChC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACjD,aAAA;;YAGD,IAAI,CAAC,KAAK,CAAC,8BAA8B,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE;gBAC1E,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AACtD,aAAA;;YAGD,IAAI,OAAO,GAAG,EAAE,CAAC;YACjB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;gBACpC,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;AACpD,oBAAA,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC;AAC7B,iBAAA;AAAM,qBAAA;AACL,oBAAA,OAAO,CAAC,KAAK,CACX,2HAA2H,CAC5H,CAAC;AACH,iBAAA;AACF,aAAA;AAAM,iBAAA;AACL,gBAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;AAC7C,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AACjC,iBAAA;AACF,aAAA;YAED,IAAI,IAAI,GAAG,mDAAmD,CAAC;AAC/D,YAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;AAC7C,gBAAA,IAAI,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5D,IAAI;oBACF,0GAA0G;AAC1G,wBAAA,KAAK,CAAC,eAAe;wBACrB,GAAG;AACH,wBAAA,KAAK,CAAC,iBAAiB;wBACvB,6CAA6C;wBAC7C,CAAC;wBACD,iBAAiB;wBACjB,CAAC;wBACD,IAAI;wBACJ,GAAG;AACH,wBAAA,QAAQ,CAAC;AACZ,aAAA;YACD,IAAI,IAAI,QAAQ,CAAC;;AAGjB,YAAA,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,EAAE;AACzB,gBAAA,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC;AACtB,aAAA;AAED,YAAA,eAAe,CAAC,SAAS,GAAG,IAAI,CAAC;YAEjC,IAAI,KAAK,CAAC,8BAA8B,EAAE;AACxC,gBAAA,eAAe,EAAE,CAAC;AAClB,gBAAA,cAAc,EAAE,CAAC;AAClB,aAAA;AAAM,iBAAA;AACL,gBAAA,eAAe,EAAE,CAAC;AACnB,aAAA;;AAGD,YAAA,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;;YAG9B,IAAI,OAAO,KAAK,IAAI,EAAE;AACpB,gBAAA,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;AAChC,gBAAA,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAC7B,aAAA;AAAM,iBAAA;AACL,gBAAA,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;AACnB,aAAA;;AAGD,YAAA,IAAI,KAAK,CAAC,cAAc,KAAK,IAAI,EAAE;gBACjC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,MAAK;AACrC,oBAAA,SAAS,EAAE,CAAC;AACd,iBAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;AAC1B,aAAA;AAED,YAAA,OAAO,EAAE,CAAC;AACZ,SAAC,CAAC;;QAGF,SAAS,cAAc,CAAC,MAAM,EAAA;;AAE5B,YAAA,IAAI,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAChC,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;YACzC,IAAI,OAAO,KAAK,IAAI,EAAE;AACpB,gBAAA,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;AAC9B,gBAAA,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC;AAC/C,aAAA;AACD,YAAA,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AACnC,YAAA,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC;;AAGjB,YAAA,eAAe,EAAE,CAAC;YAElB,IAAI,KAAK,CAAC,mBAAmB,EAAE;AAC7B,gBAAA,SAAS,EAAE,CAAC;AACb,aAAA;SACF;;QAGD,MAAM,SAAS,GAAG,MAAK;;AAErB,YAAA,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;;;YAI1C,IAAI,OAAO,KAAK,IAAI,EAAE;AACpB,gBAAA,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;AACnB,aAAA;AAAM,iBAAA;AACL,gBAAA,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;AACpB,aAAA;YAED,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACnD,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;;AAGxD,YAAA,IAAI,UAAU,GAAG;gBACf,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,QAAQ,EAAE,QAAQ,CAAC,MAAM;aAC1B,CAAC;;AAGF,YAAA,eAAe,CAAC,SAAS,GAAG,EAAE,CAAC;;AAG/B,YAAA,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAErC,YAAA,cAAc,EAAE,CAAC;AACnB,SAAC,CAAC;AAEF,QAAA,MAAM,yBAAyB,GAAG,CAAC,KAAa,KAAI;YAClD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC;AACzE,SAAC,CAAC;QAEF,SAAS,eAAe,CAAC,CAAC,EAAA;AACxB,YAAA,IAAI,MAAM,GAAG,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;YACzD,cAAc,CAAC,MAAM,CAAC,CAAC;SACxB;AAED,QAAA,SAAS,eAAe,GAAA;YACtB,IAAI,IAAI,GAAG,QAAQ,CAAC,gBAAgB,CAAC,uCAAuC,CAAC,CAAC;AAC9E,YAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACpC,IAAI,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAC7C,gBAAA,IAAI,MAAM,EAAE;AACV,oBAAA,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;AACxB,iBAAA;gBACD,IAAI,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AACvD,aAAA;SACF;AAED,QAAA,SAAS,4BAA4B,GAAA;YACnC,IAAI,IAAI,GAAG,QAAQ,CAAC,gBAAgB,CAAC,uCAAuC,CAAC,CAAC;AAC9E,YAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACpC,IAAI,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAC7C,gBAAA,IAAI,MAAM,EAAE;AACV,oBAAA,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;AACzB,iBAAA;gBACD,IAAI,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AACpD,aAAA;SACF;AAED,QAAA,SAAS,cAAc,GAAA;AACrB,YAAA,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,EAAE;AACjC,gBAAA,yBAAyB,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;AACtD,aAAA;AAAM,iBAAA;AACL,gBAAA,4BAA4B,EAAE,CAAC;AAChC,aAAA;SACF;AAED,QAAA,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,KAAI;YAC7B,cAAc,GAAG,OAAO,CAAC;AAC3B,SAAC,CAAC,CAAC;KACJ;AAED,IAAA,QAAQ,CACN,KAAsB,EACtB,eAAe,EACf,kBAAuB,EACvB,aAAyB,EAAA;QAEzB,IAAI,eAAe,IAAI,WAAW,EAAE;AAClC,YAAA,aAAa,EAAE,CAAC;AAChB,YAAA,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;AACpD,SAAA;QACD,IAAI,eAAe,IAAI,QAAQ,EAAE;YAC/B,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,kBAAkB,EAAE,aAAa,CAAC,CAAC;AAChE,SAAA;KACF;IAEO,sBAAsB,CAAC,KAAsB,EAAE,kBAAkB,EAAA;AACvE,QAAA,MAAM,YAAY,GAAG;YACnB,QAAQ,EAAE,KAAK,CAAC,QAAQ;AACxB,YAAA,EAAE,EACA,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,EAAE,IAAI,CAAC;AACnE,gBAAA,KAAK,CAAC,mBAAmB;AAC3B,YAAA,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;SAC5E,CAAC;AAEF,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;QAE1F,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,+BAA+B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAEpE,QAAA,OAAO,IAAI,CAAC;KACb;IAEO,kBAAkB,CAAC,KAAsB,EAAE,kBAAkB,EAAA;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;AAEpE,QAAA,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;KAChC;AAEO,IAAA,eAAe,CAAC,KAAsB,EAAE,kBAAkB,EAAE,aAAyB,EAAA;QAC3F,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;QAEpE,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAEzD,MAAM,OAAO,GAAG,MAAK;AACnB,YAAA,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,WAAW,CAChC,eAAe,CAAC,aAAa,CAAC,oBAAoB,IAAI,CAAC,QAAQ,CAAW,SAAA,CAAA,CAAC,EAC3E,IAAI,CAAC,EAAE,CACR,CAAC;AACH,aAAA;AACH,SAAC,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,EAAE,MAAK;AACtC,YAAA,aAAa,EAAE,CAAC;AAChB,YAAA,IAAI,CAAC,KAAK,CAAC,8BAA8B,EAAE;gBACzC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC/C,aAAA;AAAM,iBAAA;AACL,gBAAA,OAAO,EAAE,CAAC;AACX,aAAA;AACH,SAAC,CAAC,CAAC;KACJ;;AArRM,yBAAI,CAAA,IAAA,GAAG,IAAI;;;;"}
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import autoBind from \"auto-bind\";\nimport { JsPsych, JsPsychPlugin, ParameterType, TrialType } from \"jspsych\";\n\nimport { AudioPlayerInterface } from \"../../jspsych/src/modules/plugin-api/AudioPlayer\";\nimport { version } from \"../package.json\";\n\nconst info = <const>{\n  name: \"audio-button-response\",\n  version: version,\n  parameters: {\n    /** Path to audio file to be played. */\n    stimulus: {\n      type: ParameterType.AUDIO,\n      default: undefined,\n    },\n    /** Labels for the buttons. Each different string in the array will generate a different button.  */\n    choices: {\n      type: ParameterType.STRING,\n      default: undefined,\n      array: true,\n    },\n    /**\n     * A function that generates the HTML for each button in the `choices` array. The function gets the string\n     * and index of the item in the `choices` array and should return valid HTML. If you want to use different\n     * markup for each button, you can do that by using a conditional on either parameter. The default parameter\n     * returns a button element with the text label of the choice.\n     */\n    button_html: {\n      type: ParameterType.FUNCTION,\n      default: function (choice: string, choice_index: number) {\n        return `<button class=\"jspsych-btn\">${choice}</button>`;\n      },\n    },\n    /** This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention\n     *  is that it can be used to provide a reminder about the action the participant is supposed to take\n     * (e.g., which key to press). */\n    prompt: {\n      type: ParameterType.HTML_STRING,\n      default: null,\n    },\n    /** How long to wait for the participant to make a response before ending the trial in milliseconds. If the\n     * participant fails to make a response before this timer is reached, the participant's response will be\n     * recorded as null for the trial and the trial will end. If the value of this parameter is null, the trial\n     * will wait for a response indefinitely */\n    trial_duration: {\n      type: ParameterType.INT,\n      default: null,\n    },\n    /** Setting to `'grid'` will make the container element have the CSS property `display: grid` and enable the\n     * use of `grid_rows` and `grid_columns`. Setting to `'flex'` will make the container element have the CSS\n     * property `display: flex`. You can customize how the buttons are laid out by adding inline CSS in the `button_html` parameter.\n     */\n    button_layout: {\n      type: ParameterType.STRING,\n      default: \"grid\",\n    },\n    /** The number of rows in the button grid. Only applicable when `button_layout` is set to `'grid'`. If null, the\n     * number of rows will be determined automatically based on the number of buttons and the number of columns.\n     */\n    grid_rows: {\n      type: ParameterType.INT,\n      default: 1,\n    },\n    /** The number of columns in the button grid. Only applicable when `button_layout` is set to `'grid'`.\n     * If null, the number of columns will be determined automatically based on the number of buttons and the\n     * number of rows.\n     */\n    grid_columns: {\n      type: ParameterType.INT,\n      default: null,\n    },\n    /** If true, then the trial will end whenever the participant makes a response (assuming they make their\n     * response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will\n     * continue until the value for `trial_duration` is reached. You can set this parameter to `false` to force\n     * the participant to listen to the stimulus for a fixed amount of time, even if they respond before the time is complete. */\n    response_ends_trial: {\n      type: ParameterType.BOOL,\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      default: false,\n    },\n    /**\n     * If true, then responses are allowed while the audio is playing. If false, then the audio must finish\n     * playing before the button choices are enabled and a response is accepted. Once the audio has played\n     * all the way through, the buttons are enabled and a response is allowed (including while the audio is\n     * being re-played via on-screen playback controls).\n     */\n    response_allowed_while_playing: {\n      type: ParameterType.BOOL,\n      default: true,\n    },\n    /** How long the button will delay enabling in milliseconds. If `response_allowed_while_playing` is `true`,\n     * the timer will start immediately. If it is `false`, the timer will start at the end of the audio. */\n    enable_button_after: {\n      type: ParameterType.INT,\n      default: 0,\n    },\n  },\n  data: {\n    /** The response time in milliseconds for the participant to make a response. The time is measured from\n     * when the stimulus first began playing until the participant's response.*/\n    rt: {\n      type: ParameterType.INT,\n    },\n    /** Indicates which button the participant pressed. The first button in the `choices` array is 0, the second is 1, and so on. */\n    response: {\n      type: ParameterType.INT,\n    },\n  },\n};\n\ntype Info = typeof info;\n\n/**\n * If the browser supports it, audio files are played using the WebAudio API. This allows for reasonably precise \n * timing of the playback. The timing of responses generated is measured against the WebAudio specific clock, \n * improving the measurement of response times. If the browser does not support the WebAudio API, then the audio file is \n * played with HTML5 audio. \n\n * Audio files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if \n * you are using timeline variables or another dynamic method to specify the audio stimulus, you will need \n * to [manually preload](../overview/media-preloading.md#manual-preloading) the audio.\n\n * The trial can end when the participant responds, when the audio file has finished playing, or if the participant \n * has failed to respond within a fixed length of time. You can also prevent a button response from being made before the \n * audio has finished playing.\n * \n * @author Kristin Diep\n * @see {@link https://www.jspsych.org/latest/plugins/audio-button-response/ audio-button-response plugin documentation on jspsych.org}\n */\nclass AudioButtonResponsePlugin implements JsPsychPlugin<Info> {\n  static info = info;\n  private audio: AudioPlayerInterface;\n  private params: TrialType<Info>;\n  private buttonElements: HTMLElement[] = [];\n  private display: HTMLElement;\n  private response: { rt: number; button: number } = { rt: null, button: null };\n  private context: AudioContext;\n  private startTime: number;\n  private trial_complete: (trial_data: { rt: number; stimulus: string; response: number }) => void;\n\n  constructor(private jsPsych: JsPsych) {\n    autoBind(this);\n  }\n\n  async trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void) {\n    // hold the .resolve() function from the Promise that ends the trial\n    this.trial_complete;\n    this.params = trial;\n    this.display = display_element;\n    // setup stimulus\n    this.context = this.jsPsych.pluginAPI.audioContext();\n\n    // load audio file\n    this.audio = await this.jsPsych.pluginAPI.getAudioPlayer(trial.stimulus);\n\n    // set up end event if trial needs it\n    if (trial.trial_ends_after_audio) {\n      this.audio.addEventListener(\"ended\", this.end_trial);\n    }\n\n    // enable buttons after audio ends if necessary\n    if (!trial.response_allowed_while_playing && !trial.trial_ends_after_audio) {\n      this.audio.addEventListener(\"ended\", this.enable_buttons);\n    }\n\n    // Display buttons\n    const buttonGroupElement = document.createElement(\"div\");\n    buttonGroupElement.id = \"jspsych-audio-button-response-btngroup\";\n    if (trial.button_layout === \"grid\") {\n      buttonGroupElement.classList.add(\"jspsych-btn-group-grid\");\n      if (trial.grid_rows === null && trial.grid_columns === null) {\n        throw new Error(\n          \"You cannot set `grid_rows` to `null` without providing a value for `grid_columns`.\"\n        );\n      }\n      const n_cols =\n        trial.grid_columns === null\n          ? Math.ceil(trial.choices.length / trial.grid_rows)\n          : trial.grid_columns;\n      const n_rows =\n        trial.grid_rows === null\n          ? Math.ceil(trial.choices.length / trial.grid_columns)\n          : trial.grid_rows;\n      buttonGroupElement.style.gridTemplateColumns = `repeat(${n_cols}, 1fr)`;\n      buttonGroupElement.style.gridTemplateRows = `repeat(${n_rows}, 1fr)`;\n    } else if (trial.button_layout === \"flex\") {\n      buttonGroupElement.classList.add(\"jspsych-btn-group-flex\");\n    }\n\n    for (const [choiceIndex, choice] of trial.choices.entries()) {\n      buttonGroupElement.insertAdjacentHTML(\"beforeend\", trial.button_html(choice, choiceIndex));\n      const buttonElement = buttonGroupElement.lastChild as HTMLElement;\n      buttonElement.dataset.choice = choiceIndex.toString();\n      buttonElement.addEventListener(\"click\", () => {\n        this.after_response(choiceIndex);\n      });\n      this.buttonElements.push(buttonElement);\n    }\n\n    display_element.appendChild(buttonGroupElement);\n\n    // Show prompt if there is one\n    if (trial.prompt !== null) {\n      display_element.insertAdjacentHTML(\"beforeend\", trial.prompt);\n    }\n\n    if (trial.response_allowed_while_playing) {\n      if (trial.enable_button_after > 0) {\n        this.disable_buttons();\n        this.enable_buttons();\n      }\n    } else {\n      this.disable_buttons();\n    }\n\n    // start time\n    this.startTime = performance.now();\n\n    // end trial if time limit is set\n    if (trial.trial_duration !== null) {\n      this.jsPsych.pluginAPI.setTimeout(() => {\n        this.end_trial();\n      }, trial.trial_duration);\n    }\n\n    on_load();\n\n    this.audio.play();\n\n    return new Promise((resolve) => {\n      this.trial_complete = resolve;\n    });\n  }\n\n  private disable_buttons = () => {\n    for (const button of this.buttonElements) {\n      button.setAttribute(\"disabled\", \"disabled\");\n    }\n  };\n\n  private enable_buttons_without_delay = () => {\n    for (const button of this.buttonElements) {\n      button.removeAttribute(\"disabled\");\n    }\n  };\n\n  private enable_buttons_with_delay = (delay: number) => {\n    this.jsPsych.pluginAPI.setTimeout(this.enable_buttons_without_delay, delay);\n  };\n\n  private enable_buttons() {\n    if (this.params.enable_button_after > 0) {\n      this.enable_buttons_with_delay(this.params.enable_button_after);\n    } else {\n      this.enable_buttons_without_delay();\n    }\n  }\n\n  // function to handle responses by the subject\n  private after_response = (choice) => {\n    // measure rt\n    var endTime = performance.now();\n    var rt = Math.round(endTime - this.startTime);\n    if (this.context !== null) {\n      endTime = this.context.currentTime;\n      rt = Math.round((endTime - this.startTime) * 1000);\n    }\n    this.response.button = parseInt(choice);\n    this.response.rt = rt;\n\n    // disable all the buttons after a response\n    this.disable_buttons();\n\n    if (this.params.response_ends_trial) {\n      this.end_trial();\n    }\n  };\n\n  // method to end trial when it is time\n  private end_trial = () => {\n    // stop the audio file if it is playing\n    this.audio.stop();\n\n    // remove end event listeners if they exist\n    this.audio.removeEventListener(\"ended\", this.end_trial);\n    this.audio.removeEventListener(\"ended\", this.enable_buttons);\n\n    // gather the data to store for the trial\n    var trial_data = {\n      rt: this.response.rt,\n      stimulus: this.params.stimulus,\n      response: this.response.button,\n    };\n\n    // move on to the next trial\n    this.trial_complete(trial_data);\n  };\n\n  async simulate(\n    trial: TrialType<Info>,\n    simulation_mode,\n    simulation_options: any,\n    load_callback: () => void\n  ) {\n    if (simulation_mode == \"data-only\") {\n      load_callback();\n      this.simulate_data_only(trial, simulation_options);\n    }\n    if (simulation_mode == \"visual\") {\n      this.simulate_visual(trial, simulation_options, load_callback);\n    }\n  }\n\n  private create_simulation_data(trial: TrialType<Info>, simulation_options) {\n    const default_data = {\n      stimulus: trial.stimulus,\n      rt:\n        this.jsPsych.randomization.sampleExGaussian(500, 50, 1 / 150, true) +\n        trial.enable_button_after,\n      response: this.jsPsych.randomization.randomInt(0, trial.choices.length - 1),\n    };\n\n    const data = this.jsPsych.pluginAPI.mergeSimulationData(default_data, simulation_options);\n\n    this.jsPsych.pluginAPI.ensureSimulationDataConsistency(trial, data);\n\n    return data;\n  }\n\n  private simulate_data_only(trial: TrialType<Info>, simulation_options) {\n    const data = this.create_simulation_data(trial, simulation_options);\n\n    this.jsPsych.finishTrial(data);\n  }\n\n  private simulate_visual(trial: TrialType<Info>, simulation_options, load_callback: () => void) {\n    const data = this.create_simulation_data(trial, simulation_options);\n\n    const display_element = this.jsPsych.getDisplayElement();\n\n    const respond = () => {\n      if (data.rt !== null) {\n        this.jsPsych.pluginAPI.clickTarget(\n          display_element.querySelector(\n            `#jspsych-audio-button-response-btngroup [data-choice=\"${data.response}\"]`\n          ),\n          data.rt\n        );\n      }\n    };\n\n    this.trial(display_element, trial, () => {\n      load_callback();\n      if (!trial.response_allowed_while_playing) {\n        this.audio.addEventListener(\"ended\", respond);\n      } else {\n        respond();\n      }\n    });\n  }\n}\n\nexport default AudioButtonResponsePlugin;\n"],"names":["version","ParameterType"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,MAAM,IAAc,GAAA;AAAA,EAClB,IAAM,EAAA,uBAAA;AAAA,WACNA,gBAAA;AAAA,EACA,UAAY,EAAA;AAAA,IAEV,QAAU,EAAA;AAAA,MACR,MAAMC,qBAAc,CAAA,KAAA;AAAA,MACpB,OAAS,EAAA,KAAA,CAAA;AAAA,KACX;AAAA,IAEA,OAAS,EAAA;AAAA,MACP,MAAMA,qBAAc,CAAA,MAAA;AAAA,MACpB,OAAS,EAAA,KAAA,CAAA;AAAA,MACT,KAAO,EAAA,IAAA;AAAA,KACT;AAAA,IAOA,WAAa,EAAA;AAAA,MACX,MAAMA,qBAAc,CAAA,QAAA;AAAA,MACpB,OAAA,EAAS,SAAU,MAAA,EAAgB,YAAsB,EAAA;AACvD,QAAA,OAAO,CAA+B,4BAAA,EAAA,MAAA,CAAA,SAAA,CAAA,CAAA;AAAA,OACxC;AAAA,KACF;AAAA,IAIA,MAAQ,EAAA;AAAA,MACN,MAAMA,qBAAc,CAAA,WAAA;AAAA,MACpB,OAAS,EAAA,IAAA;AAAA,KACX;AAAA,IAKA,cAAgB,EAAA;AAAA,MACd,MAAMA,qBAAc,CAAA,GAAA;AAAA,MACpB,OAAS,EAAA,IAAA;AAAA,KACX;AAAA,IAKA,aAAe,EAAA;AAAA,MACb,MAAMA,qBAAc,CAAA,MAAA;AAAA,MACpB,OAAS,EAAA,MAAA;AAAA,KACX;AAAA,IAIA,SAAW,EAAA;AAAA,MACT,MAAMA,qBAAc,CAAA,GAAA;AAAA,MACpB,OAAS,EAAA,CAAA;AAAA,KACX;AAAA,IAKA,YAAc,EAAA;AAAA,MACZ,MAAMA,qBAAc,CAAA,GAAA;AAAA,MACpB,OAAS,EAAA,IAAA;AAAA,KACX;AAAA,IAKA,mBAAqB,EAAA;AAAA,MACnB,MAAMA,qBAAc,CAAA,IAAA;AAAA,MACpB,OAAS,EAAA,IAAA;AAAA,KACX;AAAA,IAEA,sBAAwB,EAAA;AAAA,MACtB,MAAMA,qBAAc,CAAA,IAAA;AAAA,MACpB,OAAS,EAAA,KAAA;AAAA,KACX;AAAA,IAOA,8BAAgC,EAAA;AAAA,MAC9B,MAAMA,qBAAc,CAAA,IAAA;AAAA,MACpB,OAAS,EAAA,IAAA;AAAA,KACX;AAAA,IAGA,mBAAqB,EAAA;AAAA,MACnB,MAAMA,qBAAc,CAAA,GAAA;AAAA,MACpB,OAAS,EAAA,CAAA;AAAA,KACX;AAAA,GACF;AAAA,EACA,IAAM,EAAA;AAAA,IAGJ,EAAI,EAAA;AAAA,MACF,MAAMA,qBAAc,CAAA,GAAA;AAAA,KACtB;AAAA,IAEA,QAAU,EAAA;AAAA,MACR,MAAMA,qBAAc,CAAA,GAAA;AAAA,KACtB;AAAA,GACF;AACF,CAAA,CAAA;AAqBA,MAAM,yBAAyD,CAAA;AAAA,EAW7D,YAAoB,OAAkB,EAAA;AAAlB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AAPpB,IAAA,IAAA,CAAQ,iBAAgC,EAAC,CAAA;AAEzC,IAAA,IAAA,CAAQ,QAA2C,GAAA,EAAE,EAAI,EAAA,IAAA,EAAM,QAAQ,IAAK,EAAA,CAAA;AAmG5E,IAAA,IAAA,CAAQ,kBAAkB,MAAM;AAC9B,MAAW,KAAA,MAAA,MAAA,IAAU,KAAK,cAAgB,EAAA;AACxC,QAAO,MAAA,CAAA,YAAA,CAAa,YAAY,UAAU,CAAA,CAAA;AAAA,OAC5C;AAAA,KACF,CAAA;AAEA,IAAA,IAAA,CAAQ,+BAA+B,MAAM;AAC3C,MAAW,KAAA,MAAA,MAAA,IAAU,KAAK,cAAgB,EAAA;AACxC,QAAA,MAAA,CAAO,gBAAgB,UAAU,CAAA,CAAA;AAAA,OACnC;AAAA,KACF,CAAA;AAEA,IAAQ,IAAA,CAAA,yBAAA,GAA4B,CAAC,KAAkB,KAAA;AACrD,MAAA,IAAA,CAAK,OAAQ,CAAA,SAAA,CAAU,UAAW,CAAA,IAAA,CAAK,8BAA8B,KAAK,CAAA,CAAA;AAAA,KAC5E,CAAA;AAWA,IAAQ,IAAA,CAAA,cAAA,GAAiB,CAAC,MAAW,KAAA;AAEnC,MAAI,IAAA,OAAA,GAAU,YAAY,GAAI,EAAA,CAAA;AAC9B,MAAA,IAAI,EAAK,GAAA,IAAA,CAAK,KAAM,CAAA,OAAA,GAAU,KAAK,SAAS,CAAA,CAAA;AAC5C,MAAI,IAAA,IAAA,CAAK,YAAY,IAAM,EAAA;AACzB,QAAA,OAAA,GAAU,KAAK,OAAQ,CAAA,WAAA,CAAA;AACvB,QAAA,EAAA,GAAK,IAAK,CAAA,KAAA,CAAA,CAAO,OAAU,GAAA,IAAA,CAAK,aAAa,GAAI,CAAA,CAAA;AAAA,OACnD;AACA,MAAK,IAAA,CAAA,QAAA,CAAS,MAAS,GAAA,QAAA,CAAS,MAAM,CAAA,CAAA;AACtC,MAAA,IAAA,CAAK,SAAS,EAAK,GAAA,EAAA,CAAA;AAGnB,MAAA,IAAA,CAAK,eAAgB,EAAA,CAAA;AAErB,MAAI,IAAA,IAAA,CAAK,OAAO,mBAAqB,EAAA;AACnC,QAAA,IAAA,CAAK,SAAU,EAAA,CAAA;AAAA,OACjB;AAAA,KACF,CAAA;AAGA,IAAA,IAAA,CAAQ,YAAY,MAAM;AAExB,MAAA,IAAA,CAAK,MAAM,IAAK,EAAA,CAAA;AAGhB,MAAA,IAAA,CAAK,KAAM,CAAA,mBAAA,CAAoB,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACtD,MAAA,IAAA,CAAK,KAAM,CAAA,mBAAA,CAAoB,OAAS,EAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAG3D,MAAA,IAAI,UAAa,GAAA;AAAA,QACf,EAAA,EAAI,KAAK,QAAS,CAAA,EAAA;AAAA,QAClB,QAAA,EAAU,KAAK,MAAO,CAAA,QAAA;AAAA,QACtB,QAAA,EAAU,KAAK,QAAS,CAAA,MAAA;AAAA,OAC1B,CAAA;AAGA,MAAA,IAAA,CAAK,eAAe,UAAU,CAAA,CAAA;AAAA,KAChC,CAAA;AA3JE,IAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,GACf;AAAA,EAEA,MAAM,KAAA,CAAM,eAA8B,EAAA,KAAA,EAAwB,OAAqB,EAAA;AAErF,IAAK,IAAA,CAAA,cAAA,CAAA;AACL,IAAA,IAAA,CAAK,MAAS,GAAA,KAAA,CAAA;AACd,IAAA,IAAA,CAAK,OAAU,GAAA,eAAA,CAAA;AAEf,IAAA,IAAA,CAAK,OAAU,GAAA,IAAA,CAAK,OAAQ,CAAA,SAAA,CAAU,YAAa,EAAA,CAAA;AAGnD,IAAA,IAAA,CAAK,QAAQ,MAAM,IAAA,CAAK,QAAQ,SAAU,CAAA,cAAA,CAAe,MAAM,QAAQ,CAAA,CAAA;AAGvE,IAAA,IAAI,MAAM,sBAAwB,EAAA;AAChC,MAAA,IAAA,CAAK,KAAM,CAAA,gBAAA,CAAiB,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAAA,KACrD;AAGA,IAAA,IAAI,CAAC,KAAA,CAAM,8BAAkC,IAAA,CAAC,MAAM,sBAAwB,EAAA;AAC1E,MAAA,IAAA,CAAK,KAAM,CAAA,gBAAA,CAAiB,OAAS,EAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAAA,KAC1D;AAGA,IAAM,MAAA,kBAAA,GAAqB,QAAS,CAAA,aAAA,CAAc,KAAK,CAAA,CAAA;AACvD,IAAA,kBAAA,CAAmB,EAAK,GAAA,wCAAA,CAAA;AACxB,IAAI,IAAA,KAAA,CAAM,kBAAkB,MAAQ,EAAA;AAClC,MAAmB,kBAAA,CAAA,SAAA,CAAU,IAAI,wBAAwB,CAAA,CAAA;AACzD,MAAA,IAAI,KAAM,CAAA,SAAA,KAAc,IAAQ,IAAA,KAAA,CAAM,iBAAiB,IAAM,EAAA;AAC3D,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,oFAAA;AAAA,SACF,CAAA;AAAA,OACF;AACA,MAAA,MAAM,MACJ,GAAA,KAAA,CAAM,YAAiB,KAAA,IAAA,GACnB,IAAK,CAAA,IAAA,CAAK,KAAM,CAAA,OAAA,CAAQ,MAAS,GAAA,KAAA,CAAM,SAAS,CAAA,GAChD,KAAM,CAAA,YAAA,CAAA;AACZ,MAAA,MAAM,MACJ,GAAA,KAAA,CAAM,SAAc,KAAA,IAAA,GAChB,IAAK,CAAA,IAAA,CAAK,KAAM,CAAA,OAAA,CAAQ,MAAS,GAAA,KAAA,CAAM,YAAY,CAAA,GACnD,KAAM,CAAA,SAAA,CAAA;AACZ,MAAmB,kBAAA,CAAA,KAAA,CAAM,sBAAsB,CAAU,OAAA,EAAA,MAAA,CAAA,MAAA,CAAA,CAAA;AACzD,MAAmB,kBAAA,CAAA,KAAA,CAAM,mBAAmB,CAAU,OAAA,EAAA,MAAA,CAAA,MAAA,CAAA,CAAA;AAAA,KACxD,MAAA,IAAW,KAAM,CAAA,aAAA,KAAkB,MAAQ,EAAA;AACzC,MAAmB,kBAAA,CAAA,SAAA,CAAU,IAAI,wBAAwB,CAAA,CAAA;AAAA,KAC3D;AAEA,IAAA,KAAA,MAAW,CAAC,WAAa,EAAA,MAAM,KAAK,KAAM,CAAA,OAAA,CAAQ,SAAW,EAAA;AAC3D,MAAA,kBAAA,CAAmB,mBAAmB,WAAa,EAAA,KAAA,CAAM,WAAY,CAAA,MAAA,EAAQ,WAAW,CAAC,CAAA,CAAA;AACzF,MAAA,MAAM,gBAAgB,kBAAmB,CAAA,SAAA,CAAA;AACzC,MAAc,aAAA,CAAA,OAAA,CAAQ,MAAS,GAAA,WAAA,CAAY,QAAS,EAAA,CAAA;AACpD,MAAc,aAAA,CAAA,gBAAA,CAAiB,SAAS,MAAM;AAC5C,QAAA,IAAA,CAAK,eAAe,WAAW,CAAA,CAAA;AAAA,OAChC,CAAA,CAAA;AACD,MAAK,IAAA,CAAA,cAAA,CAAe,KAAK,aAAa,CAAA,CAAA;AAAA,KACxC;AAEA,IAAA,eAAA,CAAgB,YAAY,kBAAkB,CAAA,CAAA;AAG9C,IAAI,IAAA,KAAA,CAAM,WAAW,IAAM,EAAA;AACzB,MAAgB,eAAA,CAAA,kBAAA,CAAmB,WAAa,EAAA,KAAA,CAAM,MAAM,CAAA,CAAA;AAAA,KAC9D;AAEA,IAAA,IAAI,MAAM,8BAAgC,EAAA;AACxC,MAAI,IAAA,KAAA,CAAM,sBAAsB,CAAG,EAAA;AACjC,QAAA,IAAA,CAAK,eAAgB,EAAA,CAAA;AACrB,QAAA,IAAA,CAAK,cAAe,EAAA,CAAA;AAAA,OACtB;AAAA,KACK,MAAA;AACL,MAAA,IAAA,CAAK,eAAgB,EAAA,CAAA;AAAA,KACvB;AAGA,IAAK,IAAA,CAAA,SAAA,GAAY,YAAY,GAAI,EAAA,CAAA;AAGjC,IAAI,IAAA,KAAA,CAAM,mBAAmB,IAAM,EAAA;AACjC,MAAK,IAAA,CAAA,OAAA,CAAQ,SAAU,CAAA,UAAA,CAAW,MAAM;AACtC,QAAA,IAAA,CAAK,SAAU,EAAA,CAAA;AAAA,OACjB,EAAG,MAAM,cAAc,CAAA,CAAA;AAAA,KACzB;AAEA,IAAQ,OAAA,EAAA,CAAA;AAER,IAAA,IAAA,CAAK,MAAM,IAAK,EAAA,CAAA;AAEhB,IAAO,OAAA,IAAI,OAAQ,CAAA,CAAC,OAAY,KAAA;AAC9B,MAAA,IAAA,CAAK,cAAiB,GAAA,OAAA,CAAA;AAAA,KACvB,CAAA,CAAA;AAAA,GACH;AAAA,EAkBQ,cAAiB,GAAA;AACvB,IAAI,IAAA,IAAA,CAAK,MAAO,CAAA,mBAAA,GAAsB,CAAG,EAAA;AACvC,MAAK,IAAA,CAAA,yBAAA,CAA0B,IAAK,CAAA,MAAA,CAAO,mBAAmB,CAAA,CAAA;AAAA,KACzD,MAAA;AACL,MAAA,IAAA,CAAK,4BAA6B,EAAA,CAAA;AAAA,KACpC;AAAA,GACF;AAAA,EA0CA,MAAM,QAAA,CACJ,KACA,EAAA,eAAA,EACA,oBACA,aACA,EAAA;AACA,IAAA,IAAI,mBAAmB,WAAa,EAAA;AAClC,MAAc,aAAA,EAAA,CAAA;AACd,MAAK,IAAA,CAAA,kBAAA,CAAmB,OAAO,kBAAkB,CAAA,CAAA;AAAA,KACnD;AACA,IAAA,IAAI,mBAAmB,QAAU,EAAA;AAC/B,MAAK,IAAA,CAAA,eAAA,CAAgB,KAAO,EAAA,kBAAA,EAAoB,aAAa,CAAA,CAAA;AAAA,KAC/D;AAAA,GACF;AAAA,EAEQ,sBAAA,CAAuB,OAAwB,kBAAoB,EAAA;AACzE,IAAA,MAAM,YAAe,GAAA;AAAA,MACnB,UAAU,KAAM,CAAA,QAAA;AAAA,MAChB,EAAA,EACE,IAAK,CAAA,OAAA,CAAQ,aAAc,CAAA,gBAAA,CAAiB,GAAK,EAAA,EAAA,EAAI,CAAI,GAAA,GAAA,EAAK,IAAI,CAAA,GAClE,KAAM,CAAA,mBAAA;AAAA,MACR,QAAA,EAAU,KAAK,OAAQ,CAAA,aAAA,CAAc,UAAU,CAAG,EAAA,KAAA,CAAM,OAAQ,CAAA,MAAA,GAAS,CAAC,CAAA;AAAA,KAC5E,CAAA;AAEA,IAAA,MAAM,OAAO,IAAK,CAAA,OAAA,CAAQ,SAAU,CAAA,mBAAA,CAAoB,cAAc,kBAAkB,CAAA,CAAA;AAExF,IAAA,IAAA,CAAK,OAAQ,CAAA,SAAA,CAAU,+BAAgC,CAAA,KAAA,EAAO,IAAI,CAAA,CAAA;AAElE,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEQ,kBAAA,CAAmB,OAAwB,kBAAoB,EAAA;AACrE,IAAA,MAAM,IAAO,GAAA,IAAA,CAAK,sBAAuB,CAAA,KAAA,EAAO,kBAAkB,CAAA,CAAA;AAElE,IAAK,IAAA,CAAA,OAAA,CAAQ,YAAY,IAAI,CAAA,CAAA;AAAA,GAC/B;AAAA,EAEQ,eAAA,CAAgB,KAAwB,EAAA,kBAAA,EAAoB,aAA2B,EAAA;AAC7F,IAAA,MAAM,IAAO,GAAA,IAAA,CAAK,sBAAuB,CAAA,KAAA,EAAO,kBAAkB,CAAA,CAAA;AAElE,IAAM,MAAA,eAAA,GAAkB,IAAK,CAAA,OAAA,CAAQ,iBAAkB,EAAA,CAAA;AAEvD,IAAA,MAAM,UAAU,MAAM;AACpB,MAAI,IAAA,IAAA,CAAK,OAAO,IAAM,EAAA;AACpB,QAAA,IAAA,CAAK,QAAQ,SAAU,CAAA,WAAA;AAAA,UACrB,eAAgB,CAAA,aAAA;AAAA,YACd,yDAAyD,IAAK,CAAA,QAAA,CAAA,EAAA,CAAA;AAAA,WAChE;AAAA,UACA,IAAK,CAAA,EAAA;AAAA,SACP,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAEA,IAAK,IAAA,CAAA,KAAA,CAAM,eAAiB,EAAA,KAAA,EAAO,MAAM;AACvC,MAAc,aAAA,EAAA,CAAA;AACd,MAAI,IAAA,CAAC,MAAM,8BAAgC,EAAA;AACzC,QAAK,IAAA,CAAA,KAAA,CAAM,gBAAiB,CAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAAA,OACvC,MAAA;AACL,QAAQ,OAAA,EAAA,CAAA;AAAA,OACV;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAA;AAvOM,yBAAA,CACG,IAAO,GAAA,IAAA;;;;"}

package/dist/index.d.ts

@@ -1,173 +1,255 @@
-import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
+import { JsPsychPlugin, ParameterType, JsPsych, TrialType } from 'jspsych';
+
 declare const info: {
     readonly name: "audio-button-response";
+    readonly version: string;
     readonly parameters: {
-        /** The audio to be played. */
+        /** Path to audio file to be played. */
         readonly stimulus: {
             readonly type: ParameterType.AUDIO;
-            readonly pretty_name: "Stimulus";
             readonly default: any;
         };
-        /** Array containing the label(s) for the button(s). */
+        /** Labels for the buttons. Each different string in the array will generate a different button.  */
         readonly choices: {
             readonly type: ParameterType.STRING;
-            readonly pretty_name: "Choices";
             readonly default: any;
             readonly array: true;
         };
-        /** The HTML for creating button. Can create own style. Use the "%choice%" string to indicate where the label from the choices parameter should be inserted. */
+        /**
+         * A function that generates the HTML for each button in the `choices` array. The function gets the string
+         * and index of the item in the `choices` array and should return valid HTML. If you want to use different
+         * markup for each button, you can do that by using a conditional on either parameter. The default parameter
+         * returns a button element with the text label of the choice.
+         */
         readonly button_html: {
-            readonly type: ParameterType.HTML_STRING;
-            readonly pretty_name: "Button HTML";
-            readonly default: "<button class=\"jspsych-btn\">%choice%</button>";
-            readonly array: true;
+            readonly type: ParameterType.FUNCTION;
+            readonly default: (choice: string, choice_index: number) => string;
         };
-        /** Any content here will be displayed below the stimulus. */
+        /** This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention
+         *  is that it can be used to provide a reminder about the action the participant is supposed to take
+         * (e.g., which key to press). */
         readonly prompt: {
             readonly type: ParameterType.HTML_STRING;
-            readonly pretty_name: "Prompt";
             readonly default: any;
         };
-        /** The maximum duration to wait for a response. */
+        /** How long to wait for the participant to make a response before ending the trial in milliseconds. If the
+         * participant fails to make a response before this timer is reached, the participant's response will be
+         * recorded as null for the trial and the trial will end. If the value of this parameter is null, the trial
+         * will wait for a response indefinitely */
         readonly trial_duration: {
             readonly type: ParameterType.INT;
-            readonly pretty_name: "Trial duration";
             readonly default: any;
         };
-        /** Vertical margin of button. */
-        readonly margin_vertical: {
+        /** Setting to `'grid'` will make the container element have the CSS property `display: grid` and enable the
+         * use of `grid_rows` and `grid_columns`. Setting to `'flex'` will make the container element have the CSS
+         * property `display: flex`. You can customize how the buttons are laid out by adding inline CSS in the `button_html` parameter.
+         */
+        readonly button_layout: {
             readonly type: ParameterType.STRING;
-            readonly pretty_name: "Margin vertical";
-            readonly default: "0px";
+            readonly default: "grid";
         };
-        /** Horizontal margin of button. */
-        readonly margin_horizontal: {
-            readonly type: ParameterType.STRING;
-            readonly pretty_name: "Margin horizontal";
-            readonly default: "8px";
+        /** The number of rows in the button grid. Only applicable when `button_layout` is set to `'grid'`. If null, the
+         * number of rows will be determined automatically based on the number of buttons and the number of columns.
+         */
+        readonly grid_rows: {
+            readonly type: ParameterType.INT;
+            readonly default: 1;
+        };
+        /** The number of columns in the button grid. Only applicable when `button_layout` is set to `'grid'`.
+         * If null, the number of columns will be determined automatically based on the number of buttons and the
+         * number of rows.
+         */
+        readonly grid_columns: {
+            readonly type: ParameterType.INT;
+            readonly default: any;
         };
-        /** If true, the trial will end when user makes a response. */
+        /** If true, then the trial will end whenever the participant makes a response (assuming they make their
+         * response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will
+         * continue until the value for `trial_duration` is reached. You can set this parameter to `false` to force
+         * the participant to listen to the stimulus for a fixed amount of time, even if they respond before the time is complete. */
         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. */
+        /** 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.
+         * If true, then responses are allowed while the audio is playing. If false, then the audio must finish
+         * playing before the button choices are enabled and a response is accepted. Once the audio has played
+         * all the way through, the buttons are enabled and a response is allowed (including while the audio is
+         * being re-played via on-screen playback controls).
          */
         readonly response_allowed_while_playing: {
             readonly type: ParameterType.BOOL;
-            readonly pretty_name: "Response allowed while playing";
             readonly default: true;
         };
-        /** The delay of enabling button */
+        /** How long the button will delay enabling in milliseconds. If `response_allowed_while_playing` is `true`,
+         * the timer will start immediately. If it is `false`, the timer will start at the end of the audio. */
         readonly enable_button_after: {
             readonly type: ParameterType.INT;
-            readonly pretty_name: "Enable button after";
             readonly default: 0;
         };
     };
+    readonly data: {
+        /** The response time in milliseconds for the participant to make a response. The time is measured from
+         * when the stimulus first began playing until the participant's response.*/
+        readonly rt: {
+            readonly type: ParameterType.INT;
+        };
+        /** Indicates which button the participant pressed. The first button in the `choices` array is 0, the second is 1, and so on. */
+        readonly response: {
+            readonly type: ParameterType.INT;
+        };
+    };
 };
 type Info = typeof info;
 /**
- * **audio-button-response**
- *
- * jsPsych plugin for playing an audio file and getting a button response
+ * If the browser supports it, audio files are played using the WebAudio API. This allows for reasonably precise
+ * timing of the playback. The timing of responses generated is measured against the WebAudio specific clock,
+ * improving the measurement of response times. If the browser does not support the WebAudio API, then the audio file is
+ * played with HTML5 audio.
+
+ * Audio files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if
+ * you are using timeline variables or another dynamic method to specify the audio stimulus, you will need
+ * to [manually preload](../overview/media-preloading.md#manual-preloading) the audio.
+
+ * The trial can end when the participant responds, when the audio file has finished playing, or if the participant
+ * has failed to respond within a fixed length of time. You can also prevent a button response from being made before the
+ * audio has finished playing.
  *
  * @author Kristin Diep
- * @see {@link https://www.jspsych.org/plugins/jspsych-audio-button-response/ audio-button-response plugin documentation on jspsych.org}
+ * @see {@link https://www.jspsych.org/latest/plugins/audio-button-response/ audio-button-response plugin documentation on jspsych.org}
  */
 declare class AudioButtonResponsePlugin implements JsPsychPlugin<Info> {
     private jsPsych;
     static info: {
         readonly name: "audio-button-response";
+        readonly version: string;
         readonly parameters: {
-            /** The audio to be played. */
+            /** Path to audio file to be played. */
             readonly stimulus: {
                 readonly type: ParameterType.AUDIO;
-                readonly pretty_name: "Stimulus";
                 readonly default: any;
             };
-            /** Array containing the label(s) for the button(s). */
+            /** Labels for the buttons. Each different string in the array will generate a different button.  */
             readonly choices: {
                 readonly type: ParameterType.STRING;
-                readonly pretty_name: "Choices";
                 readonly default: any;
                 readonly array: true;
             };
-            /** The HTML for creating button. Can create own style. Use the "%choice%" string to indicate where the label from the choices parameter should be inserted. */
+            /**
+             * A function that generates the HTML for each button in the `choices` array. The function gets the string
+             * and index of the item in the `choices` array and should return valid HTML. If you want to use different
+             * markup for each button, you can do that by using a conditional on either parameter. The default parameter
+             * returns a button element with the text label of the choice.
+             */
             readonly button_html: {
-                readonly type: ParameterType.HTML_STRING;
-                readonly pretty_name: "Button HTML";
-                readonly default: "<button class=\"jspsych-btn\">%choice%</button>";
-                readonly array: true;
+                readonly type: ParameterType.FUNCTION;
+                readonly default: (choice: string, choice_index: number) => string;
             };
-            /** Any content here will be displayed below the stimulus. */
+            /** This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention
+             *  is that it can be used to provide a reminder about the action the participant is supposed to take
+             * (e.g., which key to press). */
             readonly prompt: {
                 readonly type: ParameterType.HTML_STRING;
-                readonly pretty_name: "Prompt";
                 readonly default: any;
             };
-            /** The maximum duration to wait for a response. */
+            /** How long to wait for the participant to make a response before ending the trial in milliseconds. If the
+             * participant fails to make a response before this timer is reached, the participant's response will be
+             * recorded as null for the trial and the trial will end. If the value of this parameter is null, the trial
+             * will wait for a response indefinitely */
             readonly trial_duration: {
                 readonly type: ParameterType.INT;
-                readonly pretty_name: "Trial duration";
                 readonly default: any;
             };
-            /** Vertical margin of button. */
-            readonly margin_vertical: {
+            /** Setting to `'grid'` will make the container element have the CSS property `display: grid` and enable the
+             * use of `grid_rows` and `grid_columns`. Setting to `'flex'` will make the container element have the CSS
+             * property `display: flex`. You can customize how the buttons are laid out by adding inline CSS in the `button_html` parameter.
+             */
+            readonly button_layout: {
                 readonly type: ParameterType.STRING;
-                readonly pretty_name: "Margin vertical";
-                readonly default: "0px";
+                readonly default: "grid";
             };
-            /** Horizontal margin of button. */
-            readonly margin_horizontal: {
-                readonly type: ParameterType.STRING;
-                readonly pretty_name: "Margin horizontal";
-                readonly default: "8px";
+            /** The number of rows in the button grid. Only applicable when `button_layout` is set to `'grid'`. If null, the
+             * number of rows will be determined automatically based on the number of buttons and the number of columns.
+             */
+            readonly grid_rows: {
+                readonly type: ParameterType.INT;
+                readonly default: 1;
             };
-            /** If true, the trial will end when user makes a response. */
+            /** The number of columns in the button grid. Only applicable when `button_layout` is set to `'grid'`.
+             * If null, the number of columns will be determined automatically based on the number of buttons and the
+             * number of rows.
+             */
+            readonly grid_columns: {
+                readonly type: ParameterType.INT;
+                readonly default: any;
+            };
+            /** If true, then the trial will end whenever the participant makes a response (assuming they make their
+             * response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will
+             * continue until the value for `trial_duration` is reached. You can set this parameter to `false` to force
+             * the participant to listen to the stimulus for a fixed amount of time, even if they respond before the time is complete. */
             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. */
+            /** 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.
+             * If true, then responses are allowed while the audio is playing. If false, then the audio must finish
+             * playing before the button choices are enabled and a response is accepted. Once the audio has played
+             * all the way through, the buttons are enabled and a response is allowed (including while the audio is
+             * being re-played via on-screen playback controls).
              */
             readonly response_allowed_while_playing: {
                 readonly type: ParameterType.BOOL;
-                readonly pretty_name: "Response allowed while playing";
                 readonly default: true;
             };
-            /** The delay of enabling button */
+            /** How long the button will delay enabling in milliseconds. If `response_allowed_while_playing` is `true`,
+             * the timer will start immediately. If it is `false`, the timer will start at the end of the audio. */
             readonly enable_button_after: {
                 readonly type: ParameterType.INT;
-                readonly pretty_name: "Enable button after";
                 readonly default: 0;
             };
         };
+        readonly data: {
+            /** The response time in milliseconds for the participant to make a response. The time is measured from
+             * when the stimulus first began playing until the participant's response.*/
+            readonly rt: {
+                readonly type: ParameterType.INT;
+            };
+            /** Indicates which button the participant pressed. The first button in the `choices` array is 0, the second is 1, and so on. */
+            readonly response: {
+                readonly type: ParameterType.INT;
+            };
+        };
     };
     private audio;
+    private params;
+    private buttonElements;
+    private display;
+    private response;
+    private context;
+    private startTime;
+    private trial_complete;
     constructor(jsPsych: JsPsych);
     trial(display_element: HTMLElement, trial: TrialType<Info>, on_load: () => void): Promise<unknown>;
-    simulate(trial: TrialType<Info>, simulation_mode: any, simulation_options: any, load_callback: () => void): void;
+    private disable_buttons;
+    private enable_buttons_without_delay;
+    private enable_buttons_with_delay;
+    private enable_buttons;
+    private after_response;
+    private end_trial;
+    simulate(trial: TrialType<Info>, simulation_mode: any, simulation_options: any, load_callback: () => void): Promise<void>;
     private create_simulation_data;
     private simulate_data_only;
     private simulate_visual;
 }
-export default AudioButtonResponsePlugin;
+
+export { AudioButtonResponsePlugin as default };