sourecode/obs-websocket-php

PHP implementation of the OBS WebSocket API

dev-master 2024-05-20 17:39 UTC

Requires

• php: ^8.3
• phrity/websocket: ^2.2
• symfony/clock: ^7.0
• symfony/config: ^7.0
• symfony/dependency-injection: ^7.0
• symfony/finder: ^7.0
• symfony/http-kernel: ^7.0
• symfony/property-access: ^7.0
• symfony/serializer: ^7.0
• symfony/string: ^7.0
• symfony/uid: ^7.0

Requires (Dev)

• nikic/php-parser: ^5.0
• roave/security-advisories: dev-latest
• symfony/filesystem: ^7.0
• symfony/process: ^7.0

MIT

• chapterjason

README

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.