[FEATURE] Remote Control API
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 20/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- cpp, grpc, openapi
调研方向
No files, tests, or entry points are named. Start by resolving the API protocol, supported UI operations, authentication, and HTTPS requirements described in the issue. Done would require an agreed scope and a complete remote-control API implementation rather than a single isolated change.
由索引模型根据 Issue 内容生成。
描述
There are so many use cases which require projectMSDL to be controlled by external events, devices or a remote PC, that it makes sense to implement a remote control API. This API should be able to perform any task which can be achieved via the UI, like changing settings, playback control, listing/changing audio devices and editing preset playlists on the fly.
Other inputs for controlling the preset playback, e.g. via MIDI events, can then be implemented via the API instead of adding all the use-case specific functionality directly into the UI. This will also make it possible to reconfigure those external inputs at runtime without visually disturbing projectMSDL, as the UI doesn't have to be opened.
The API should use a protocol which is easy to use either from a website or any custom application. There are three general ways to implement it technically:
- JSON RPC via HTTP/1.1: The most basic API possible, used in many web applications. Uses simple request-response calls from the client to projectMSDL. Ideally using Open API 3 to create the specification.
- Bi-directional communication via Websockets: Allows communication in both directions, but Websockets are not supported by some HTTP client frameworks.
- gRPC via HTTP/2.0: A mix of the above, using HTTP2 streams. By default uses a request-response mechanism, but clients can also subscribe to specific "events" on the server to be notified if something changes.
Currently, the only events which would make server-side events necessary is automatically switching presets (to get the new preset name) and possibly a change of the current audio device. In the first case, this info could simply be polled every second or so if needed. That would make the JSON RPC API the preferred one for a first implementation. The other ones could also be done later if there's need.
Authentication should use the standard OAuth protocol.
For environments which require it, e.g. open networks or even the internet, projectMSDL should also support using HTTPS. In this case, the user has to supply the proper SSL keys and certificates, generated via OpenSSL or a compatible tool.
- 主要语言
- C++
- 星标
- 118
- 派生
- 64
- 平均合并
- 26 天 20 小时
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
projectM-visualizer/frontend-sdl-cpp 的其他 Issue
-
enhancement
难度 5/5 一周以上 新手友好度 25/100
-
难度 5/5 一周以上 新手友好度 30/100
projectM-visualizer/frontend-sdl-cpp#134 · 4 条评论 ·
-
难度 5/5 一周以上 新手友好度 35/100
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
projectM-visualizer/frontend-sdl-cpp#120 · 1 条评论 ·
-
enhancement
难度 5/5 一周以上 新手友好度 25/100
projectM-visualizer/frontend-sdl-cpp#118 · 2 条评论 ·
查看 projectM-visualizer/frontend-sdl-cpp 的全部 Issue
相似的 Issue
-
Component: Python API
难度 2/5 1-3 小时 新手友好度 70/100
Vector35/binaryninja-api#8649 ·
维护者通常 3 天内回复
-
ai_p2 comp-parquet-reader-v3
难度 2/5 半天 新手友好度 66/100
ClickHouse/ClickHouse#124986 ·
维护者通常 1 天内回复
-
bug product: very_good_flutter_plugin
难度 1/5 1-3 小时 新手友好度 78/100
VeryGoodOpenSource/very_good_templates#654 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
AcademySoftwareFoundation/OpenImageIO#5550 ·
维护者通常 2 天内回复