add headphone-check plugin

[jadeddelta]

hi all, this PR adds the headphone check plugin, a simple yet customizable way to check if a user is wearing headphones or not. this plugin attempts to recreate the functionality of the original HeadphoneCheck plugin described in the 2017 paper that speaks to its efficacy.

all functionality of the original package has been implemented in the style of jsPsych, with a simple boolean at the end to tell if the participant has passed the check or not. to view this plugin for yourself, be sure to do the usual: cd into the plugin-headphone-check directory, run npm i and npm run build, and run the example in /examples/basic-configuration.html. this'll recreate the original parameters as described in the original HeadphoneCheck plugin.

any reviewers would be greatly appreciated, this is my first plugin after all ;^) but i had a blast making it and i can't wait to see how people will use this!

[jodeleeuw]

awesome! here are some quick initial thoughts

[jodeleeuw]

Maybe a quick update here?

[jadeddelta]

I created a dummy test, but I can't for the life of me figure out how to mock the AudioPlayer class...

[jodeleeuw]

I mocked the AudioPlayer class in jspsych/jsPsych#3179 and some use cases are shown in the commits here jspsych/jsPsych@d296962

[jodeleeuw]

Also, perhaps it is worth looking into whether the audio files can be distributed via the cdn?

[changeset-bot]

🦋 Changeset detected

Latest commit: 31db640

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@jspsych-contrib/plugin-headphone-check	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[jadeddelta]

Also, perhaps it is worth looking into whether the audio files can be distributed via the cdn?

at this point, it would be interesting to look into adding that functionality to the AudioPlayer class itself so that we can standardize (unless i'm mistaken and you can do it via cdn already)

[jodeleeuw]

Also, perhaps it is worth looking into whether the audio files can be distributed via the cdn?

at this point, it would be interesting to look into adding that functionality to the AudioPlayer class itself so that we can standardize (unless i'm mistaken and you can do it via cdn already)

Wouldn't you still need the audio files themselves to be available? I think I'm missing something.

[jodeleeuw]

I think we can add the audio files to the files list in the package.json and then they'll be published and accessible?

https://docs.npmjs.com/cli/v10/configuring-npm/package-json#files

[jadeddelta]

Also, perhaps it is worth looking into whether the audio files can be distributed via the cdn?

at this point, it would be interesting to look into adding that functionality to the AudioPlayer class itself so that we can standardize (unless i'm mistaken and you can do it via cdn already)

Wouldn't you still need the audio files themselves to be available? I think I'm missing something.

my understanding of loading media in jsPsych is that you pass a file path in local memory to the trial- so i'm confused how passing in a link to the cdn that contains the file works in this case

[jodeleeuw]

my understanding of loading media in jsPsych is that you pass a file path in local memory to the trial- so i'm confused how passing in a link to the cdn that contains the file works in this case

No, we're passing a URL. When experiments are hosted online the media files have to be hosted on a server, and so the audio file is loaded from the URL. One issue that we might run into is CORS requests. Loading media from remote URLs may cause issues. Worth investigating...