fixes an enqueu issue and updated the doc

Author: formix

README.md

@@ -49,8 +49,8 @@ The code adds all videos to the playlist, in declaration order. After the `for`
 video (`BadWeather`) is displayed in the paused state, but you may not notice that since there is
 no sleep before the play command is called. Then the whole thing is played in that sequence:
 
-  1. The `BadWeather` video is played for 25 seconds.
-  2. Activate the repeat mode for the video that is actually running.
+  1. The `BadWeather` video starts.
+  2. Activate the repeat mode.
   3. Sleep 25 seconds. Since `BadWather` is only 20 seconds long, it will repeat and play for another 5 seconds.
   4. The `Tornado` video starts.
   5. Turn off video repetion.
@@ -68,5 +68,11 @@ From there, you got the gist of it. You could as well repeat the whole sequence
 into a while loop instead of closing. You could aso leave the `CropField` video run indefinitely
 or until a given event.
 
+You can also call `player.exec()` to execute any rc command that is not implemented right away. If
+you think that there is some other good abstraction to add to the player, feel free to implement
+that function send a pull request my way! Want to make it work under another OS? Don't ask me
+what I can do for you, ask yourself what you can do to make it happend... and send me a pull
+request with your own cross platform implemetation!
+
 I developped this module after the OMX Player deprecation for my escape games consulting work.
 Tested and working on Raspberry PI 4 with the minimal Raspbian image (console only).

lib/index.mjs

@@ -20,7 +20,7 @@ export class VlcPlayer {
 
     /**
      * Open the VLC media player with an empty playlist. VLC will not take
-     * over the display until the first media is enqueueed to the playlist.
+     * over the display until the first media is added to the playlist.
      */
     async open() {
         return new Promise((resolve, reject) => {
@@ -44,9 +44,9 @@ export class VlcPlayer {
     }
 
     /**
-     * Start playing after being paused or enqueue the given file at the end of
-     * the playlist and start playing it. If the file is already in the
-     * playlist, jump to that media position in the playlist instead.
+     * Start playing after being paused or enqueue the given file at the end
+     * of the playlist. If the file is already in the playlist, jump to that
+     * media position in the playlist instead.
      * 
      * @param {string=} mediaPath - If unspecified, resumes the running video. If a valid media path is specified, start playing that media.
      */
@@ -56,7 +56,7 @@ export class VlcPlayer {
         }
         else {
             if (!this._playlist.has(mediaPath)) {
-                await this.enqueue(mediaPath);
+                await this.add(mediaPath);
             }
             let index = this._playlist.get(mediaPath);
             await this.exec(`goto ${index}`);
@@ -71,7 +71,7 @@ export class VlcPlayer {
     }
 
     /**
-     * Enqueue the specified media at the end of the playlist.
+     * Add the specified media at the end of the playlist.
      * 
      * @param {string} mediaPath The path of the media to play.
      */
@@ -121,7 +121,7 @@ export class VlcPlayer {
      * @param {string} command - The command to execute.
      */
     exec(command) {
-        return new Promise((resolve, reject) => {
+        return new Promise((resolve, reject) => { 
             if (!command) {
                 return reject("The command parameter must be provided.");
             }