Skip to content

SDK 命名空间

SDK 通过全局 fb 对象提供以下命名空间(共 40 个 namespace)。

R12 VitePress SDK 覆盖门禁当前按 SDK wrapper 视角统计为 386 个 method / 0 个文档示例调用缺口;下表“数量”列沿用 API reference / host capability 口径,可能包含状态、事件或非 wrapper 入口,因此不等同于 R12 统计口径。

核心命名空间

命名空间描述数量示例
fb.player播放控制27fb.player.play()
fb.playlist播放列表管理47fb.playlist.getAll()
fb.library媒体库操作25fb.library.search('query')
fb.ui窗口控制82fb.ui.minimize()
fb.config配置管理29fb.config.get('key')
fb.artwork封面获取14fb.artwork.getCurrent()
fb.audio音频分析14fb.audio.subscribeSpectrum()
fb.utils工具函数3fb.utils.formatTitle()
fb.system系统信息9fb.system.listApis()
fb.shell系统集成5fb.shell.openExternal(url)
fb.state响应式状态-fb.state.isPlaying
命名空间描述数量示例
fb.file文件读写10fb.file.read(path)
fb.httpHTTP 请求9fb.http.get(url)
fb.dialog对话框4fb.dialog.openFile()
fb.clipboard剪贴板4fb.clipboard.read()
命名空间描述数量示例
fb.dspDSP 预设8fb.dsp.getChain()
fb.output输出设备3fb.output.getDevices()
fb.replaygainReplayGain8fb.replaygain.getMode()
命名空间描述数量示例
fb.queue播放队列8fb.queue.get()
fb.jitQueueJIT 即时队列8fb.jitQueue.enqueueNext()
fb.discovery服务发现15fb.discovery.getAllServices()
fb.keyboard全局快捷键4fb.keyboard.registerHotkey()
命名空间描述数量示例
fb.metadata元数据读写10fb.metadata.read(path)
fb.titleformatTitleformat5fb.titleformat.eval()
fb.playcount播放统计4fb.playcount.get(path)
fb.selection选择同步6fb.selection.get()
fb.rating评分2fb.rating.set(path, 5)
命名空间描述数量示例
fb.portPortHub 跨窗口端口5fb.port.connect('main')
fb.event跨窗口事件-fb.event.emit('refresh')
fb.sharedState跨窗口共享状态-fb.sharedState.get('theme')
命名空间描述数量示例
fb.cursor光标控制2fb.cursor.set('hand')
fb.taskbar任务栏按钮5fb.taskbar.setProgress(50)
fb.tray系统托盘13fb.tray.showBalloon(opts)
命名空间描述数量示例
fb.menu菜单命令6fb.menu.runMainMenuCommand()
fb.console控制台3fb.console.log(msg)
fb.log日志文件3fb.log.write(msg)
fb.lyrics歌词3fb.lyrics.get()
fb.notification通知/菜单4fb.notification.showToast()
fb.panel面板配置2fb.panel.getConfig()
fb.misc杂项工具9fb.misc.restart()
fb.dnd拖放4fb.dnd.registerDropZone()

各命名空间详细文档:

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

扩展: file-io | audio-ext | navigation | data | misc

桌面集成: cursor API | taskbar/tray API