From 0bb4b1025e9c0578d405faaf2dfd0e611f2c66c7 Mon Sep 17 00:00:00 2001 From: theodiablo Date: Wed, 11 Dec 2019 17:40:31 +0100 Subject: [PATCH] Update playing documentation in README.md Update the documentation of playing function, the description is clearly saying that if no ID is passed, there will be a result anyway, which makes id parameter optional. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1df9fe6a..d9772001 100644 --- a/README.md +++ b/README.md @@ -287,9 +287,9 @@ Get/set whether to loop the sound or group. This method can optionally take 0, 1 #### state() Check the load status of the `Howl`, returns a `unloaded`, `loading` or `loaded`. -#### playing(id) +#### playing([id]) Check if a sound is currently playing or not, returns a `Boolean`. If no sound ID is passed, check if any sound in the `Howl` group is playing. -* **id**: `Number` The sound ID to check. +* **id**: `Number` `optional` The sound ID to check. #### duration([id]) Get the duration of the audio source (in seconds). Will return 0 until after the `load` event fires.