OBS浏览器插件技术文档

OBS浏览器插件技术文档

obs-browser 项目地址: https://gitcode.com/gh_mirrors/obs/obs-browser

OBS浏览器插件是一款为OBS Studio量身打造的跨平台插件，它利用了Chromium Embedded Framework（CEF）的强大功能，使用户能够在直播场景中集成web-based覆盖层。此外，该插件支持服务集成和在界面内加载网页的浏览器停靠功能，适用于除Wayland之外的所有Linux平台。此插件已成为官方Windows、macOS、Ubuntu PPA以及通过Flatpak分发的Linux发行版的标准组成部分。

安装指南

预包装版本

对于大多数用户，OBS浏览器插件已包含在OBS Studio的官方发布包中。Windows、macOS用户直接安装最新版本的OBS Studio即可。Linux用户可以通过添加官方 Flatpak 或使用包含插件的Ubuntu PPA来获取。

# 在Linux上通过Flatpak安装OBS Studio
flatpak install flathub com.obsproject.Studio

自行构建

如果您需要从源代码编译插件，须遵循以下步骤：

Windows

• 遵循OBS Studio的Windows构建指示。
• 确保下载CEF Wrapper，并将CEF_ROOT_DIR环境变量指向解压后的目录。

macOS

• 使用OBS Studio提供的macOS全构建脚本，这会自动处理一切。

Linux

• 按照OBS Studio的Linux构建指示，并选择“如果要构建带浏览器源”选项，确保正确设置CEF下载和CEF相关的CMake变量。

项目使用说明

通过OBS Studio的界面，您可以在场景中添加新的来源，并选择“Browser Source”以利用该插件的功能。您可以输入URL或选择本地HTML文件作为内容源，并调整显示选项以适应您的直播需求。

项目API使用文档

JavaScript绑定

插件提供了一个全局对象window.obsstudio，让您能够从JavaScript访问OBS特定功能，以便创建响应OBS状态变化的动态覆盖层。

• 获取插件版本

  const pluginVersion = window.obsstudio.pluginVersion; // 返回例如 "2.17.0"
  

• 事件监听

  可注册监听如场景改变(obsSceneChanged)等核心事件，详情见:OBS前端API参考。

• 控制OBS操作

  如获取输出状态、切换场景、控制录制与流媒体等功能，都需要指定权限级别后调用相应方法，例如：

  window.obsstudio.startStreaming(); // 开始直播
  

TypeScript类型定义

对于TypeScript用户，可通过npm或yarn安装类型定义：

npm install --save-dev @types/obs-studio
# 或者
yarn add --dev @types/obs-studio

服务集成与浏览器停靠

插件支持直接在OBS Studio界面上加载网页，实现服务集成和交互式控制，增强了直播的灵活性与互动性。

结论

通过上述指导，开发者和直播主可以深入理解OBS浏览器插件的安装、使用及其强大的API集，从而创造更加丰富和动态的直播体验。记住，随着版本更新，具体细节可能有所变动，推荐始终查阅最新的官方文档保持同步。

obs-browser 项目地址: https://gitcode.com/gh_mirrors/obs/obs-browser