HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix audio stop description

Browse Source
This commit is contained in:
jade 2024-11-04 13:39:32 -05:00
parent 3f3d984a4c
commit 4b14995d4a
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/jspsych-pluginAPI.md
View File

@ -289,7 +289,7 @@ See the `audio-keyboard-response` plugin for an example in a fuller context.
```javascript
const audio = jsPsych.pluginAPI.getAudioPlayer(filepath);
audio.play();
audio.stop();
```
#### Return value
@ -298,7 +298,7 @@ Returns nothing.
#### Description
Method that belongs to the AudioPlayer class. Stops the audio loaded into the audio buffer of the AudioPlayer instance for a particular file. If the audio is an HTML5 audio object it pauses it. If the audio is a Webaudio API object it stops it.
Method that belongs to the AudioPlayer class. Stops the audio loaded into the audio buffer of the AudioPlayer instance for a particular file. If the audio is an HTML5 audio object it pauses it. If the audio is a Webaudio API object it stops it. This will regenerate the audio player, allowing you to call the `play()` method upon it again.
#### Example
@ -310,7 +310,6 @@ const audio = await jsPsych.pluginAPI.getAudioPlayer('my-sound.mp3');
audio.play();
audio.stop();
```
See the `audio-keyboard-response` plugin for an example in a fuller context.