OBS WebSocket v5 中修改文本与图片源的正确方法-Python教程

本文详解 obs 30 内置 websocket（v5）下如何通过 `obs-websocket-py` 动态更新文本和图像源内容，重点说明 `setinputsettings` 替代已废弃的 `setsourcesettings` 和 `settextgdiplusproperties` 的完整用法。

自 OBS 28 起，官方将 WebSocket 插件深度集成至核心，并升级为协议版本 5（v5）。该版本对 API 进行了重大重构：所有基于“Source”的旧请求（如 SetSourceSettings、SetTextGDIPlusProperties）均已移除，统一由更通用、语义更清晰的 SetInputSettings 接口替代。这意味着，无论目标是 GDI+ 文本、Browser 源、Image 源还是媒体源，只要其在 OBS 中被识别为 Input（即具有可配置属性的输入项），均需通过 inputName + inputSettings 方式进行设置。

以下是适配 OBS 30 + WebSocket v5 的完整、可运行代码示例：

from obswebsocket import obsws, requests

new_image_file_path = "image.png"
source_name_text = "text"      # OBS 中文本源的名称（非显示内容）
source_name_image = "image"    # OBS 中图像源的名称

def connect():
    host = "localhost"
    port = 4455
    password = "myPassword"
    ws = obsws(host, port, password)
    ws.connect()
    run(ws)

def run(ws):
    # ✅ 正确：使用 SetInputSettings 更新图像源路径
    ws.call(requests.SetInputSettings(
        inputName=source_name_image,
        inputSettings={"file": new_image_file_path}
    ))

    # ✅ 正确：使用 SetInputSettings 更新文本源内容
    ws.call(requests.SetInputSettings(
        inputName=source_name_text,
        inputSettings={"text": "Hello from WebSocket v5!"}
    ))

if __name__ == '__main__':
    connect()

⚠️ 关键注意事项：