README.md

OBS WebSocket PHP

PHP client for obs-websocket.

Almost everything is generated based on the protocol.json. Based on that there is a BaseClient that handles all the requests and responses. And a Client that extends the BaseClient which contains all the available requests.

Under the hood, it uses phrity/websocket to connect to the OBS WebSocket.

Features

• Connect to OBS Studio via WebSocket
• Send commands to control OBS Studio
• Listen to OBS Studio events

Requirements

• PHP 8.3 or later

Installation

Install the package via Composer:

composer require sourecode/obs-websocket-php

Usage

• Sending Requests
• Event Loop
• Subscription

Documentation

Documentation is generated and available under docs.

License

The MIT License (MIT). Please see License File for more information.