DOCUMENTATION.md

foobar-control-http

• foobar-control-http
  • ~Foobar
  • ~FoobarControl
    • .getStatus() ⇒ Promise.<Foobar.Status>
    • .queueItem(itemIndex) ⇒ Promise.<Foobar.Status>
    • .dequeueItem(itemIndex) ⇒ Promise.<Foobar.Status>
    • .setFocus(itemIndex) ⇒ Promise.<Foobar.Status>
    • .removeItem(itemIndex) ⇒ Promise.<Foobar.Status>
    • .seek(percent) ⇒ Promise.<Foobar.Status>
    • .playbackOrder(playbackOrder) ⇒ Promise.<Foobar.Status>
    • .volume(volume) ⇒ Promise.<Foobar.Status>
    • .stopAfterCurrent(sac) ⇒ Promise.<Foobar.Status>
    • .stopAfterQueue(saq) ⇒ Promise.<Foobar.Status>
    • .queueRandomItems(itemsCount) ⇒ Promise.<Foobar.Status>
    • .switchPlaylist(playlistIndex) ⇒ Promise.<Foobar.Status>
    • .playlistPage(playlistPage) ⇒ Promise.<Foobar.Status>
    • .stop() ⇒ Promise.<Foobar.Status>
    • .playOrPause() ⇒ Promise.<Foobar.Status>
    • .previous() ⇒ Promise.<Foobar.Status>
    • .next() ⇒ Promise.<Foobar.Status>
    • .random() ⇒ Promise.<Foobar.Status>
    • .queueAlbum() ⇒ Promise.<Foobar.Status>
    • .emptyPlaylist() ⇒ Promise.<Foobar.Status>
    • .start(trackIndex) ⇒ Promise.<Foobar.Status>

foobar-control-http~Foobar

Contains types used by FoobarControl.

Kind: inner property of foobar-control-http

foobar-control-http~FoobarControl

Control an instance of foobar2000 through 'foo_httpcontrol' and 'ajquery'.

Kind: inner property of foobar-control-http

• ~FoobarControl
  • .getStatus() ⇒ Promise.<Foobar.Status>
  • .queueItem(itemIndex) ⇒ Promise.<Foobar.Status>
  • .dequeueItem(itemIndex) ⇒ Promise.<Foobar.Status>
  • .setFocus(itemIndex) ⇒ Promise.<Foobar.Status>
  • .removeItem(itemIndex) ⇒ Promise.<Foobar.Status>
  • .seek(percent) ⇒ Promise.<Foobar.Status>
  • .playbackOrder(playbackOrder) ⇒ Promise.<Foobar.Status>
  • .volume(volume) ⇒ Promise.<Foobar.Status>
  • .stopAfterCurrent(sac) ⇒ Promise.<Foobar.Status>
  • .stopAfterQueue(saq) ⇒ Promise.<Foobar.Status>
  • .queueRandomItems(itemsCount) ⇒ Promise.<Foobar.Status>
  • .switchPlaylist(playlistIndex) ⇒ Promise.<Foobar.Status>
  • .playlistPage(playlistPage) ⇒ Promise.<Foobar.Status>
  • .stop() ⇒ Promise.<Foobar.Status>
  • .playOrPause() ⇒ Promise.<Foobar.Status>
  • .previous() ⇒ Promise.<Foobar.Status>
  • .next() ⇒ Promise.<Foobar.Status>
  • .random() ⇒ Promise.<Foobar.Status>
  • .queueAlbum() ⇒ Promise.<Foobar.Status>
  • .emptyPlaylist() ⇒ Promise.<Foobar.Status>
  • .start(trackIndex) ⇒ Promise.<Foobar.Status>

foobarControl.getStatus() ⇒ Promise.<Foobar.Status>

Get the player's current status.

Kind: instance method of FoobarControl

foobarControl.queueItem(itemIndex) ⇒ Promise.<Foobar.Status>

Add an item into the queue by its index in the current playlist.

Kind: instance method of FoobarControl

Param	Type	Description
itemIndex	number	The 0-based index in the current playlist of the item to add to the queue.

foobarControl.dequeueItem(itemIndex) ⇒ Promise.<Foobar.Status>

Remove at item from the queue by its index in the current playlist.

Kind: instance method of FoobarControl

Param	Type	Description
itemIndex	number	The 0-based index in the current playlist of the item to remove from the queue.

foobarControl.setFocus(itemIndex) ⇒ Promise.<Foobar.Status>

Set the cursor position to an item by its index in the current playlist.

Kind: instance method of FoobarControl

Param	Type	Description
itemIndex	number	The 0-based index in the current playlist of the item to set cursor position to.

foobarControl.removeItem(itemIndex) ⇒ Promise.<Foobar.Status>

Remove an item from the current playlist.

Kind: instance method of FoobarControl

Param	Type	Description
itemIndex	number	The 0-based index in the current playlist of the item to remove.

foobarControl.seek(percent) ⇒ Promise.<Foobar.Status>

Set the caret to a certain percentage through the track.

Kind: instance method of FoobarControl

Param	Type	Description
percent	number	The desired progress through the track, as a fraction of 1.

foobarControl.playbackOrder(playbackOrder) ⇒ Promise.<Foobar.Status>

Set the playback order.

Kind: instance method of FoobarControl

Param	Type	Description
playbackOrder	Foobar.PlaybackOrder	The desired playback order.

foobarControl.volume(volume) ⇒ Promise.<Foobar.Status>

Set the volume level.

Kind: instance method of FoobarControl

Param	Type	Description
volume	number	The desired volume as a fraction of 1.

foobarControl.stopAfterCurrent(sac) ⇒ Promise.<Foobar.Status>

Set the status of the 'stop after current' flag.

Kind: instance method of FoobarControl

Param	Type	Description
sac	boolean	The desired flag status.

foobarControl.stopAfterQueue(saq) ⇒ Promise.<Foobar.Status>

Set the status of the 'stop after queue' flag.

Kind: instance method of FoobarControl

Param	Type	Description
saq	boolean	The desired flag status.

foobarControl.queueRandomItems(itemsCount) ⇒ Promise.<Foobar.Status>

Add a certain number of random items to the queue.

Kind: instance method of FoobarControl

Param	Type	Description
itemsCount	number	The number of items to add.

foobarControl.switchPlaylist(playlistIndex) ⇒ Promise.<Foobar.Status>

Switch playback to another playlist.

Kind: instance method of FoobarControl

Param	Type	Description
playlistIndex	number	The 0-based index of the playlist to switch to.

foobarControl.playlistPage(playlistPage) ⇒ Promise.<Foobar.Status>

Switch the view window to another page of the playlist.

Kind: instance method of FoobarControl

Param	Type	Description
playlistPage	number	The 0-based page to switch to.

foobarControl.stop() ⇒ Promise.<Foobar.Status>

Stop playback.

Kind: instance method of FoobarControl

foobarControl.playOrPause() ⇒ Promise.<Foobar.Status>

Pause or resume playback.

Kind: instance method of FoobarControl

foobarControl.previous() ⇒ Promise.<Foobar.Status>

Move playback to the previous track.

Kind: instance method of FoobarControl

foobarControl.next() ⇒ Promise.<Foobar.Status>

Move playback to the next track.

Kind: instance method of FoobarControl

foobarControl.random() ⇒ Promise.<Foobar.Status>

Move playback to a random track.

Kind: instance method of FoobarControl

foobarControl.queueAlbum() ⇒ Promise.<Foobar.Status>

Add the current track's album to the queue.

Kind: instance method of FoobarControl

foobarControl.emptyPlaylist() ⇒ Promise.<Foobar.Status>

Empty the current playlist.

Kind: instance method of FoobarControl

foobarControl.start(trackIndex) ⇒ Promise.<Foobar.Status>

Start playing, optionally specifying a specific track to play.

Kind: instance method of FoobarControl

Param	Type	Description
trackIndex	number	The 0-based index in the current playlist of the track to play.