API（Application Programming Interface, 应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节
⚠️ 不同版本存在不同的API，或删或改。本文档会收录所有API接口和用法！
⚠️ API分为 订阅API(Subscribe API) 和 实时API(Realtime API)，文档会分为两部分介绍！
📒 开放API自Ai Desktop Pet (Alpha-2.0.0np) 自引用，该版本未发布。
订阅API
| API名称 | 继承路径 | 参数 | 用途 |
| GetLive2D | subscribe.Live2D | 无 N/A | 获取Live2D属性（Live2D For Python） |
| GetWindowPosition | subscribe.Window | 无 N/A | 获取当前桌宠的相对位置 |
| GetCharacter | subscribe.Character | 无 N/A | 获取当前选择的角色 |
| GetName | subscribe.Character | 无 N/A | 获取角色的别名 |
| GetVoiceModel | subscribe.Model | 无 N/A | 获得语音模型 |
| API名称 | 继承路径 | 参数 | 用途 |
| InsertInterface | subscribe.views.Setting | widget: QWidget icon: FluentIcon text: str | 插入一个选项卡接口进入设置界面。 |
InsertInterface (subscribe.views.Setting)
- widget: 一个继承于QWidget界面，需要引用setObjectName才可以显示
- icon: 一个FluentIcon的图标
- text: 显示的文本
| API名称 | 继承路径 | 参数 | 用途 |
| SetDragAction | subscribe.actions.Register | func: callable | 给程序设置一个MIME拖放事件（当鼠标拖放后执行对应函数） |
| SetClickAction | subscribe.actions.Register | func: callable | 给程序设置一个点击事件（当鼠标点击桌宠后执行对应函数） |
| SetMouseDragAction | subscribe.actions.Register | func: callable | 给程序设置一个鼠标拖动的事件（当鼠标拖放桌宠后执行对应函数） |