API Overview
The methods a page calls with fb2k.invoke('namespace.method', params), by namespace. Events are listed in Events API. The SDK wraps these methods as fb.*; see SDK namespaces.
471 methods in 42 namespaces.
| Namespace | Methods | Documented on |
|---|---|---|
artwork | 13 | Artwork API |
audio | 17 | Audio API |
clipboard | 4 | Clipboard API |
config | 29 | Config API |
console | 3 | Console API |
cursor | 2 | Cursor API |
dialog | 4 | Dialog API |
discovery | 15 | Discovery API |
dnd | 4 | Drag and Drop API |
dsp | 8 | DSP API |
event | 2 | Event API |
file | 14 | File API |
http | 8 | Http API |
jitQueue | 8 | JIT Queue API |
jitSession | 17 | JIT Session API |
keyboard | 5 | Keyboard API |
library | 27 | Library API |
log | 3 | Log API |
lyrics | 3 | Lyrics API |
media | 2 | Media API |
menu | 8 | Menu API |
metadata | 12 | Metadata API |
misc | 9 | Misc API |
output | 3 | Output API |
panel | 2 | Panel API |
playback | 27 | Playback API |
playcount | 4 | Playcount API |
playlist | 54 | Playlist API |
port | 5 | Port API |
queue | 11 | Queue API |
rating | 2 | Rating API |
replaygain | 8 | ReplayGain API |
selection | 6 | Selection API |
shell | 5 | Shell API |
state | 4 | State API |
system | 9 | System API |
taskbar | 5 | Taskbar API |
titleformat | 5 | Titleformat API |
tray | 16 | Tray API |
ui | 5 | UI API |
webview | 1 | WebView API |
window | 82 | Window API |
Two further methods, test.echo and test.ping, exist for testing the bridge itself and are described under Test API.
Conventions
- Method names use dot format (
playback.play); event names use colon format (playback:trackChanged). Event names cannot be invoked. - Names of the form
namespace.__methodbelong to private internal pages (such as the system tray menu) and are not public APIs.