fb

Properties

fb.AlwaysOnTop	boolean	read, write
fb.ComponentPath	string	read
fb.CursorFollowPlayback	boolean	read, write
fb.FoobarPath	string	read
fb.IsPaused	boolean	read
fb.IsPlaying	boolean	read
fb.IsV2	boolean	read
fb.PlaybackFollowCursor	boolean	read, write
fb.PlaybackLength	number	read
fb.PlaybackTime	number	read, write
fb.ProfilePath	string	read
fb.ReplaygainMode	ReplaygainMode	read, write
fb.StopAfterCurrent	boolean	read, write
fb.Volume	number	read, write

Example

fb.AlwaysOnTop = !fb.AlwaysOnTop; // toggles the current value
console.log(fb.FoobarPath); // Z:\foobar2000\
fb.PlaybackTime = 60; // jump to the one minute mark

Methods

Shortcuts to main menu commands

fb.AddDirectory()
fb.AddFiles()
fb.Exit()
fb.LoadPlaylist()
fb.Next()
fb.Pause()
fb.Play()
fb.PlayOrPause()
fb.Prev()
fb.Random()
fb.SavePlaylist()
fb.ShowConsole()
fb.ShowPreferences()
fb.Stop()
fb.VolumeDown()
fb.VolumeMute()
fb.VolumeUp()

The above methods have no return value.

fb.AcquireSelectionHolder()

Note

This method and the ISelectionHolder interface were removed in 3.4.3 due to bugs affecting other components. Their replacement is the 3 ISelectionHolder methods being moved to window.

window.SetPlaylistSelectionTracking

window.SetPlaylistTracking

window.SetSelection

See how the included samples were updated here.

fb.AddLocationsAsync(window_id, paths)

Arguments
window_id	window.ID
paths	array	An array of strings which could be files, urls, playlists.

Returns a unique task_id.

Similar to plman.AddLocations except rather than specifiying a target playlist, you get a handle list generated from the supplied paths/urls which are sent to a new on_locations_added callback.

Example

var files = ["z:\\1.mp3", "z:\\2.flac"];

function on_mouse_lbtn_dblclk() {
    var task_id = fb.AddLocationsAsync(window.ID, files);
    console.log("got task_id", task_id);
}

function on_locations_added(task_id, handle_list) {
    console.log("callback task_id", task_id);
    console.log(handle_list.Count);
}

fb.CheckClipboardContents()

Returns a boolean value.

Checks clipboard contents are handles or a file selection from Windows Explorer. Use in conjunction with fb.GetClipboardContents.

fb.CheckComponent(name)

Arguments
name	string

Returns a boolean value.

Use this if your script depends on other components.

Example

if (!fb.CheckComponent("foo_playcount")) {
    utils.ShowPopupMessage("This script requires foo_playcount.", "Rating");
}

fb.ClearPlaylist()

No return value.

Clears active playlist. If you wish to clear a specific playlist, use plman.ClearPlaylist.

fb.CreateContextMenuManager()

Returns an IContextMenuManager instance.

fb.CreateHandleList([handle])

Arguments
handle	IMetadbHandle, optional

Returns an IMetadbHandleList instance.

Example

var handle = fb.GetFocusItem();
var handle_list = fb.CreateHandleList(handle);
var image_path = ...
handle_list.AttachImage(image_path, 0);
handle_list.Dispose();

fb.CreateMainMenuManager(root_name)

Arguments
root_name	string	Must be one of File, Edit, View, Playback, Library, Help.

Returns an IMainMenuManager instance.

fb.GetAlbumArtStub([art_id])

3.3.10

Arguments
art_id	AlbumArtId	Default 0.

Returns an IJSImage instance or null on failure.

fb.GetClipboardContents()

Returns an IMetadbHandleList instance.

Clipboard contents can be handles copied to the clipboard in other components, a file selection from Explorer, etc.

Example

// ==PREPROCESSOR==
// @import "%fb2k_component_path%helpers.txt"
// ==/PREPROCESSOR==

function on_mouse_rbtn_up(x, y) {
    var ap = plman.ActivePlaylist;

    // playlist_can_add_items is defined in helpers.txt, it uses
    // plman.GetPlaylistLockFilterMask to determine if the active playlist
    // permits adding items
    // MF_STRING and MF_GRAYED are also defined there.

    var can_paste_flag = playlist_can_add_items(ap) && fb.CheckClipboardContents() ? MF_STRING : MF_GRAYED;

    var menu = window.CreatePopupMenu();
    menu.AppendMenuItem(can_paste_flag, 1, "Paste");

    var idx = menu.TrackPopupMenu(x, y);
    menu.Dispose();

    if (idx == 1) {
        var handle_list = fb.GetClipboardContents();
        plman.InsertPlaylistItems(ap, plman.GetPlaylistItemCount(ap), handle_list);
        handle_list.Dispose();
    }

    return true;
}

fb.GetDSPPresets()

Returns a JSON array in string form so you need to use JSON.parse on the result.

Example

var str = fb.GetDSPPresets();
console.log(str);

Example output

[
    {
        "active": true,
        "name": "two"
    },
    {
        "active": false,
        "name": "three"
    }
]

var arr = JSON.parse(str);
console.log(arr.length); // number of presets

for (var i = 0; i < arr.length; i++) {
    if (arr[i].active) {
        // this is the active preset, do something with the name??
    }
}

fb.GetFocusItem()

Returns an IMetadbHandle instance.

Handle of the currently selected active playlist item or null on failure.

fb.GetLibraryItems([query])

Arguments
query	string	Optional. If omitted or invalid, all items will be returned.

Returns an IMetadbHandleList instance.

fb.GetNowPlaying()

Returns an IMetadbHandle instance. Now playing item or null if foobar2000 isn't playing.

fb.GetOutputDevices()

Returns a JSON array in string form so you need to use JSON.parse on the result.

Example

var str = fb.GetOutputDevices();
console.log(str);

Example output

[
    {
        "active": false,
        "device_id": "{5243F9AD-C84F-4723-8194-0788FC021BCC}",
        "name": "Null Output",
        "output_id": "{EEEB07DE-C2C8-44C2-985C-C85856D96DA1}"
    },
    {
        "active": true,
        "device_id": "{00000000-0000-0000-0000-000000000000}",
        "name": "Primary Sound Driver",
        "output_id": "{D41D2423-FBB0-4635-B233-7054F79814AB}"
    },
    {
        "active": false,
        "device_id": "{1C4EC038-97DB-48E7-9C9A-05FDED46847B}",
        "name": "Speakers (Sound Blaster Z)",
        "output_id": "{D41D2423-FBB0-4635-B233-7054F79814AB}"
    },
    {
        "active": false,
        "device_id": "{41B86272-3D6C-4A5A-8907-4FE7EBE39E7E}",
        "name": "SPDIF-Out (Sound Blaster Z)",
        "output_id": "{D41D2423-FBB0-4635-B233-7054F79814AB}"
    },
    {
        "active": false,
        "device_id": "{9CDC0FAE-2870-4AFA-8287-E86099D69076}",
        "name": "3 - BenQ BL3200 (AMD High Definition Audio Device)",
        "output_id": "{D41D2423-FBB0-4635-B233-7054F79814AB}"
    }
]

var arr = JSON.parse(str);
console.log(arr.length); // number of devices

As you can see, only one of the items in the array has active set to true so that is the device you'd want to display the name of or mark as selected in a menu.

To change device you can use fb.RunMainMenuCommand with the device name or use fb.SetOutputDevice with the device_id/output_id.

Example

RunMainMenuCommandSetOutputDevice

var str = fb.GetOutputDevices();
var arr = JSON.parse(str);
// Assuming same list from above, switch output to the last device.
fb.RunMainMenuCommand("Playback/Device/" + arr[4].name);

var str = fb.GetOutputDevices();
var arr = JSON.parse(str);
// Assuming same list from above, switch output to the last device.
fb.SetOutputDevice(arr[4].output_id, arr[4].device_id);

fb.GetSelection([flags])

Arguments
flags	number	Default 0, 1 no now playing

Returns an IMetadbHandleList instance.

fb.GetSelectionType()

Returns a SelectionType

fb.IsLibraryEnabled()

Returns a boolean value.

fb.RunContextCommand(command)

Arguments
command	string	The full path to the command must be supplied. Case is not important.

Returns true if a matching command was found, false otherwise.

Note

This method is for the currently playing file only. See also: IMetadbHandleList RunContextCommand.

fb.RunMainMenuCommand(command)

Arguments
command	string	The full path to the command must be supplied. Case is not important.

Returns true if a matching command was found, false otherwise.

fb.SetDSPPreset(idx)

Arguments
idx	number

No return value. See fb.GetDSPPresets.

fb.SetOutputDevice(output_id, device_id)

Arguments
output_id	string
device_id	string

No return value. See fb.GetOutputDevices.

fb.ShowLibrarySearchUI(query)

Arguments
query	string

No return value.

Opens the Library>Search window populated with the query you set.

fb.ShowPictureViewer(path)

Arguments
path	string

No return value.

fb.TitleFormat(pattern)

Arguments
pattern	string

Returns an ITitleFormat instance.