/** * jspsych-video-button-response * Josh de Leeuw * * plugin for playing a video file and getting a button response * * documentation: docs.jspsych.org * **/ jsPsych.plugins["video-button-response"] = (function() { var plugin = {}; jsPsych.pluginAPI.registerPreload('video-button-response', 'stimulus', 'video'); plugin.info = { name: 'video-button-response', description: '', parameters: { stimulus: { type: jsPsych.plugins.parameterType.VIDEO, pretty_name: 'Video', default: undefined, description: 'The video file to play.' }, choices: { type: jsPsych.plugins.parameterType.STRING, pretty_name: 'Choices', default: undefined, array: true, description: 'The labels for the buttons.' }, button_html: { type: jsPsych.plugins.parameterType.STRING, pretty_name: 'Button HTML', default: '', array: true, description: 'The html of the button. Can create own style.' }, prompt: { type: jsPsych.plugins.parameterType.STRING, pretty_name: 'Prompt', default: null, description: 'Any content here will be displayed below the buttons.' }, width: { type: jsPsych.plugins.parameterType.INT, pretty_name: 'Width', default: '', description: 'The width of the video in pixels.' }, height: { type: jsPsych.plugins.parameterType.INT, pretty_name: 'Height', default: '', description: 'The height of the video display in pixels.' }, autoplay: { type: jsPsych.plugins.parameterType.BOOL, pretty_name: 'Autoplay', default: true, description: 'If true, the video will begin playing as soon as it has loaded.' }, controls: { type: jsPsych.plugins.parameterType.BOOL, pretty_name: 'Controls', default: false, description: 'If true, the subject will be able to pause the video or move the playback to any point in the video.' }, start: { type: jsPsych.plugins.parameterType.FLOAT, pretty_name: 'Start', default: null, description: 'Time to start the clip.' }, stop: { type: jsPsych.plugins.parameterType.FLOAT, pretty_name: 'Stop', default: null, description: 'Time to stop the clip.' }, rate: { type: jsPsych.plugins.parameterType.FLOAT, pretty_name: 'Rate', default: 1, description: 'The playback rate of the video. 1 is normal, <1 is slower, >1 is faster.' }, trial_ends_after_video: { type: jsPsych.plugins.parameterType.BOOL, pretty_name: 'End trial after video finishes', default: false, description: 'If true, the trial will end immediately after the video finishes playing.' }, trial_duration: { type: jsPsych.plugins.parameterType.INT, pretty_name: 'Trial duration', default: null, description: 'How long to show trial before it ends.' }, margin_vertical: { type: jsPsych.plugins.parameterType.STRING, pretty_name: 'Margin vertical', default: '0px', description: 'The vertical margin of the button.' }, margin_horizontal: { type: jsPsych.plugins.parameterType.STRING, pretty_name: 'Margin horizontal', default: '8px', description: 'The horizontal margin of the button.' }, response_ends_trial: { type: jsPsych.plugins.parameterType.BOOL, pretty_name: 'Response ends trial', default: true, description: 'If true, the trial will end when subject makes a response.' }, response_allowed_while_playing: { type: jsPsych.plugins.parameterType.BOOL, pretty_name: 'Response allowed while playing', default: true, description: 'If true, then responses are allowed while the video is playing. '+ 'If false, then the video must finish playing before a response is accepted.' } } } plugin.trial = function(display_element, trial) { // setup stimulus var video_html = '
' video_html += '"; video_html += "
"; //display buttons var buttons = []; if (Array.isArray(trial.button_html)) { if (trial.button_html.length == trial.choices.length) { buttons = trial.button_html; } else { console.error('Error in video-button-response plugin. The length of the button_html array does not equal the length of the choices array'); } } else { for (var i = 0; i < trial.choices.length; i++) { buttons.push(trial.button_html); } } video_html += '
'; for (var i = 0; i < trial.choices.length; i++) { var str = buttons[i].replace(/%choice%/g, trial.choices[i]); video_html += '
'+str+'
'; } video_html += '
'; // add prompt if there is one if (trial.prompt !== null) { video_html += trial.prompt; } display_element.innerHTML = video_html; var start_time = performance.now(); var video_element = display_element.querySelector('#jspsych-video-button-response-stimulus'); if(video_preload_blob){ video_element.src = video_preload_blob; } video_element.onended = function(){ if(trial.trial_ends_after_video){ end_trial(); } else if (!trial.response_allowed_while_playing) { enable_buttons(); } } video_element.playbackRate = trial.rate; // if video start time is specified, hide the video and set the starting time // before showing and playing, so that the video doesn't automatically show the first frame if(trial.start !== null){ video_element.pause(); video_element.currentTime = trial.start; video_element.onseeked = function() { video_element.style.visibility = "visible"; if (trial.autoplay) { video_element.play(); } } } if(trial.stop !== null){ video_element.addEventListener('timeupdate', function(e){ var currenttime = video_element.currentTime; if(currenttime >= trial.stop){ video_element.pause(); } }) } if(trial.response_allowed_while_playing){ enable_buttons(); } else { disable_buttons(); } // store response var response = { rt: null, button: null }; // function to end trial when it is time function end_trial() { // kill any remaining setTimeout handlers jsPsych.pluginAPI.clearAllTimeouts(); // stop the video file if it is playing // remove any remaining end event handlers display_element.querySelector('#jspsych-video-button-response-stimulus').pause(); display_element.querySelector('#jspsych-video-button-response-stimulus').onended = function() {}; // gather the data to store for the trial var trial_data = { rt: response.rt, stimulus: trial.stimulus, response: response.button }; // clear the display display_element.innerHTML = ''; // move on to the next trial jsPsych.finishTrial(trial_data); } // function to handle responses by the subject function after_response(choice) { // measure rt var end_time = performance.now(); var rt = end_time - start_time; response.button = parseInt(choice); response.rt = rt; // after a valid response, the stimulus will have the CSS class 'responded' // which can be used to provide visual feedback that a response was recorded video_element.className += ' responded'; // disable all the buttons after a response disable_buttons(); if (trial.response_ends_trial) { end_trial(); } } function button_response(e){ var choice = e.currentTarget.getAttribute('data-choice'); // don't use dataset for jsdom compatibility after_response(choice); } function disable_buttons() { var btns = document.querySelectorAll('.jspsych-video-button-response-button'); for (var i=0; i