
obs 30 内置 websocket 插件(v5)已废弃旧版 `setsourcesettings` 和 `settextgdiplusproperties` 请求,需统一使用 `setinputsettings` 更新文本和图像源设置。本文详解适配方法及关键注意事项。
自 OBS 28 起,官方将 websocket 功能深度集成进核心,并升级至协议版本 5(v5)。该版本对输入(Input)概念进行了标准化重构:所有可配置的源(如 Text (GDI+/FT2)、Image Source、Browser Source 等)均被统称为 Input,其属性必须通过 SetInputSettings 统一设置,不再区分 SetSourceSettings 或专用文本请求。
因此,原代码中使用的 requests.SetSourceSettings 和 requests.SetTextGDIPlusProperties 在 OBS 30 + obs-websocket-py 下会静默失败(无报错但无效果),因其对应的是已移除的 v4 接口。
✅ 正确做法是统一调用 requests.SetInputSettings,并确保传入的 inputName 与 OBS 中实际源名称完全一致(区分大小写、空格和特殊字符),同时 inputSettings 字典中的键需匹配目标输入类型的实际属性名:
from obswebsocket import obsws, requests new_image_file_path = "C:/path/to/image.png" # 建议使用绝对路径,避免相对路径解析失败 source_name_text = "My Text Source" # 必须与 OBS 中「来源」列表显示的名称完全相同 source_name_image = "My Image Source" def connect(): host = "localhost" port = 4455 password = "myPassword" ws = obsws(host, port, password) ws.connect() run(ws) def run(ws): # ✅ 更新图片源:设置 image source 的 'file' 属性 ws.call(requests.SetInputSettings( inputName=source_name_image, inputSettings={"file": new_image_file_path} )) # ✅ 更新文本源:设置 text (GDI+) 或 text_ft2 的 'text' 属性 ws.call(requests.SetInputSettings( inputName=source_name_text, inputSettings={"text": "Hello from WebSocket!"} )) if __name__ == '__main__': connect()
⚠️ 关键注意事项:
- 路径格式:windows 下建议使用正斜杠 / 或双反斜杠 \ 表示绝对路径(如 “C:/obs/assets/logo.png”),避免单反斜杠引发转义问题;
- 源类型验证:确保 source_name_text 对应的是 Text (GDI+) 或 Text (FreeType 2) 类型输入;若为 Browser Source,则应改用 “html” 或 “url” 字段;
- 调试技巧:调用后可立即执行 ws.call(requests.GetInputSettings(inputName=…)) 获取当前设置,确认更新是否生效;
- 错误处理:生产环境建议添加异常捕获,例如检查 response.status() 是否为 “ok”,避免因源名错误导致静默失败。
掌握 SetInputSettings 这一统一接口,不仅能正确更新文本与图像,也为后续控制音频监听、滤镜参数等高级功能奠定基础。务必以 OBS 实际界面中的源名称为准,这是成功交互的前提。