Skip to content

Commit

Permalink
add missing documentation in audio-slider-response
Browse files Browse the repository at this point in the history
  • Loading branch information
jadeddelta committed Nov 18, 2024
1 parent eaf0b93 commit 8bbd692
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/plugins/audio-slider-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ In addition to the [parameters available in all plugins](../overview/plugins.md#
| prompt | string | null | 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). |
| trial_duration | numeric | null | 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, then the trial will wait for a response indefinitely. |
| response_ends_trial | boolean | true | 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. |
| trial_ends_after_audio | boolean | false | If true, then the trial will end as soon as the audio file finishes playing. |
| response_allowed_while_playing | boolean | true | If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before the slider is enabled and the trial can end via the next button click. Once the audio has played all the way through, the slider is enabled and a response is allowed (including while the audio is being re-played via on-screen playback controls). |

## Data Generated
Expand Down

0 comments on commit 8bbd692

Please sign in to comment.