foo_ui_webview2 API

主题

队列与发现 ​

涵盖 fb.queue、fb.jitQueue、fb.discovery、fb.keyboard 四个命名空间。

fb.queue 播放队列 ​

get() ​

获取当前播放队列内容。

javascript
const q = await fb.queue.get();
// q.items: [{ path, playlist, index }, ...]

getCount() ​

获取队列中的曲目数量。返回 {count}。

add(options) ​

向队列添加曲目。

参数类型说明
optionsobject包含 playlist、index 等标识信息
javascript
await fb.queue.add({ playlist: 0, index: 5 });

addPaths(paths, options?) ​

通过路径添加曲目到队列。

javascript
await fb.queue.addPaths(['E:\\\\Music\\\\song.flac']);

remove(index) ​

移除队列中指定位置的曲目。

javascript
await fb.queue.remove(0); // 移除队列第一项

moveToTop(index) ​

将队列中指定项移到顶部。

javascript
await fb.queue.moveToTop(3);

flush() ​

刷新队列（播放下一首队列曲目）。

clear() ​

清空播放队列。

javascript
await fb.queue.clear();

fb.jitQueue JIT 即时队列 ​

JIT 队列是一种即时播放机制，插入的曲目会在当前曲目结束后立即播放。

getState() ​

获取 JIT 队列状态。

javascript
const state = await fb.jitQueue.getState();

enqueueNext(options) ​

将曲目排入"下一首播放"。

javascript
await fb.jitQueue.enqueueNext({ playlist: 0, index: 3 });

playNow(options) ​

立即播放指定曲目。

javascript
await fb.jitQueue.playNow({ playlist: 0, index: 5 });

skip() ​

跳过当前 JIT 队列项。

stop() ​

停止 JIT 队列播放。

clear() ​

清空 JIT 队列。

notifyEmpty() ​

通知 JIT 队列已清空（用于回调通知）。

fb.discovery 服务发现 ​

提供 foobar2000 内部服务、菜单命令、组件的枚举与执行能力。

getAllServices() ​

获取所有已注册的服务列表。

javascript
const r = await fb.discovery.getAllServices();

getMainMenuCommands() ​

获取所有主菜单命令。

javascript
const cmds = await fb.discovery.getMainMenuCommands();
// cmds.commands: [{ guid, name, path }, ...]

getMainMenuGroups() ​

获取主菜单分组。

executeMainMenuCommand(guid) ​

执行指定 GUID 的主菜单命令。

javascript
await fb.discovery.executeMainMenuCommand('{xxxxxxxx-...}');

getContextMenuCommands() ​

枚举所有可用的右键菜单命令。

executeContextMenuCommand(options) ​

执行右键菜单命令。

javascript
await fb.discovery.executeContextMenuCommand({ guid: '...', handles: [...] });

executeContextMenuByPath(options) ​

通过菜单路径执行右键菜单命令。

javascript
await fb.discovery.executeContextMenuByPath({ path: 'Properties', handles: [...] });

getContextMenuTree() ​

获取当前上下文（正在播放/选择）的右键菜单树。

getInputFormats() ​

获取所有支持的输入格式（解码器）。

javascript
const r = await fb.discovery.getInputFormats();
// r.formats: [{ name, extensions }, ...]

getComponents() ​

获取所有已加载的组件列表。

getUIElements() ​

获取所有 UI 元素。

getDspEntries() ​

获取所有 DSP 插件条目。

getOutputDevices() ​

获取所有输出设备。

getPreferencePages() ​

获取所有偏好设置页面。

searchCommands(query) ​

搜索菜单命令。

参数类型说明
querystring搜索关键词
javascript
const r = await fb.discovery.searchCommands('convert');

fb.keyboard 全局快捷键 ​

registerHotkey(key, action, options?) ​

注册全局快捷键。

参数类型说明
keystring快捷键组合，如 'Ctrl+Shift+P'
actionstring触发的动作标识
optionsobject可选配置
javascript
await fb.keyboard.registerHotkey('Ctrl+Shift+P', 'playPause');

registerShortcut(key, action) ​

注册快捷键（简化版）。

javascript
await fb.keyboard.registerShortcut('Space', 'toggle');

unregisterHotkey(options) ​

注销快捷键。

javascript
await fb.keyboard.unregisterHotkey({ key: 'Ctrl+Shift+P' });

getRegisteredHotkeys() ​

获取所有已注册的快捷键列表。

javascript
const r = await fb.keyboard.getRegisteredHotkeys();