d0074858bf
界面与品牌 - 默认 UI 语言固定为英文，不再跟随系统区域设置自动切换（frontend/OBSApp.cpp），用户仍可在设置中手动切换 - 程序图标更换为 CAIIC logo：exe 图标 obs-studio.ico 及界面/托盘/About 图标 obs.png - About 窗口精简为 logo + 名称 + 版本号，移除项目介绍、赞助名单、Authors/License 标签页 - 版本号定为 1.0.0（构建参数 OBS_VERSION_OVERRIDE=1.0.0） 分辨率支持 - 移除首次启动将画布强制限制为 1920x1080 的逻辑，默认使用显示器原生分辨率 - 设置-视频 与自动配置向导新增 3840x2160 / 2560x1440 预设 - 自动配置向导性能测试上限放宽至 4K60（软硬件编码数据率上限及起始分辨率钳制） 插件 - 集成 obs-shaderfilter 2.6.0（绿幕抠图/自定义着色器滤镜），并适配新版 libobs 的 gs_image_file_ex API - 补齐缺失的源码：obs-browser、obs-websocket、libdshowcapture（含 external/capture-device-support） 工程 - 新增 .gitignore，排除 deploy/ 发布目录与构建日志
6.2 KiB
obs-websocket
WebSocket API for OBS Studio.
Downloads
obs-websocket is now included by default with OBS Studio 28.0.0 and above. As such, there should be no need to download obs-websocket if you have OBS Studio > 28.0.0.
Binaries for OBS Studio < 28.0.0 on Windows, MacOS, and Linux are available in the Releases section.
Using obs-websocket
It is highly recommended to keep obs-websocket protected with a password against unauthorized control. obs-websocket generates a password for you automatically when you load it for the first time. To change this, open the "obs-websocket Settings" dialog under OBS' "Tools" menu. In the settings dialog, you can enable or disable authentication and set a password for it.
(Psst. You can use --websocket_port(value), --websocket_password(value), --websocket_debug(flag) and --websocket_ipv4_only(flag) on the command line to override the configured values.)
Possible use cases
- Remote control OBS from a phone or tablet on the same local network
- Change your stream overlay/graphics based on the current scene
- Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...)
Client software
- Macro Deck
- Touch Portal
- Twitchat
- OBS-web - hosted client at obs-web.niek.tv/
- Streamer.bot
- Deckboard
- OBS Blade
- Aitum
- Kruiz Control
- Bitfocus Companion Module
- MacroGraph - hosted client here
- MATRIC
Client libraries (for developers)
Here's a list of available language APIs for obs-websocket:
- Python 3.7+ (Asyncio): simpleobsws by IRLToolkit
- Python 3.10+ (Non-Asyncio): obsws-python by aatikturk and onyx-and-iris
- Rust: obws by dnaka91
- Godot 4.0.x: obs-websocket-gd by you-win
- Javascript (Node and web): obs-websocket-js by OBS Websocket Community
- C (uses obs-websocket-js): v8-libwebsocket-obs-websocket
- Go: goobs by andreykaipov
- Dart/Flutter (can target all supported platforms): obs_websocket by faithoflifedev
- Java: obs-websocket-java by OBS Websocket Community
The 5.x server is a typical WebSocket server running by default on port 4455 (the port number can be changed in the Settings dialog under Tools).
The protocol we use is documented in PROTOCOL.md.
We'd like to know what you're building with obs-websocket! If you do something in this fashion, feel free to drop a message in #project-showoff in the discord server!
Contributors
Code Contributors
This project exists thanks to all the people who contribute. Contribute Code.
Financial Contributors
Become a financial contributor and help us sustain our community. Contribute Financially
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website. Contribute
