Skip to content

SDK namespaces

The aggregate fb object exposes 40 runtime namespaces, plus the reactive fb.state mirror and the top-level fb.on, fb.off, fb.once, fb.invoke, fb.isAvailable(), and fb.ready() helpers.

The AST coverage gate currently reports 443 methods in the complete public facade and 0 undocumented example-call gaps. It derives that facade directly from the exported namespace objects; the narrower direct-invoke extractor remains a diagnostic subset rather than the SDK total.

Core media and UI

NamespacePurposeExample
fb.playerPlayback and volume controlfb.player.play()
fb.playlistPlaylist managementfb.playlist.getAll()
fb.libraryMedia-library queries and traversalfb.library.search('query')
fb.uiWindow and popup managementfb.ui.minimize()
fb.configPortable configuration and host settingsfb.config.get('key')
fb.artworkAlbum-art retrievalfb.artwork.getCurrent()
fb.audioAudio analysis and waveform operationsfb.audio.subscribeSpectrum()
fb.outputOutput-device queriesfb.output.getDevices()
fb.dspDSP chain and preset operationsfb.dsp.getChain()
fb.replaygainReplayGain configurationfb.replaygain.getMode()
fb.queuePlayback queuefb.queue.get()
fb.jitQueueJust-in-time queuefb.jitQueue.enqueueNext()

Metadata and data access

NamespacePurposeExample
fb.metadataMetadata reads and writesfb.metadata.read(path)
fb.titleformatTitle Formatting evaluationfb.titleformat.eval()
fb.playcountPlayback statisticsfb.playcount.get(path)
fb.ratingTrack ratingsfb.rating.set(path, 5)
fb.selectionGlobal selection synchronizationfb.selection.get()
fb.fileFile I/Ofb.file.read(path)
fb.httpHTTP requestsfb.http.get(url)
fb.clipboardClipboard accessfb.clipboard.read()
fb.dialogNative dialogsfb.dialog.openFile()

Cross-window and desktop integration

NamespacePurposeExample
fb.portNamed cross-window portsfb.port.connect('main')
fb.eventCross-window custom eventsfb.event.emit('refresh')
fb.sharedStateShared cross-window statefb.sharedState.get('theme')
fb.cursorPer-window cursor visibilityfb.cursor.setHidden(true)
fb.taskbarTaskbar buttons and progressfb.taskbar.setProgress(50)
fb.traySystem tray icon and menusfb.tray.showBalloon(opts)
fb.keyboardGlobal hotkeysfb.keyboard.registerHotkey()
fb.discoveryService and API discoveryfb.discovery.getAllServices()
fb.shellOperating-system integrationfb.shell.openExternal(url)

Utilities and host services

NamespacePurposeExample
fb.systemAPI, plugin, locale, DPI, and theme discoveryfb.system.listApis()
fb.utilsGeneral utility methodsfb.utils.formatTitle()
fb.menuMain-menu and context-menu commandsfb.menu.runMainMenuCommand()
fb.consoleHost console outputfb.console.log(msg)
fb.logLog-file operationsfb.log.write(msg)
fb.lyricsLyrics accessfb.lyrics.get()
fb.notificationToasts and notificationsfb.notification.showToast()
fb.panelPanel configurationfb.panel.getConfig()
fb.miscMiscellaneous host operationsfb.misc.restart()
fb.dndDrag-and-drop integrationfb.dnd.registerDropZone()

Core: player | playlist | library | ui | config | artwork | audio | utils | system | shell | state | events

Extended: file I/O | extended audio | navigation | data | miscellaneous

Desktop integration: cursor API | taskbar and tray API