obsproject/obs-websocket

Features

• Remote Control Interfaces - Provides a network interface to remotely manage scenes, streaming settings, and recording operations in OBS Studio.
• Remote Software Control Interfaces - Provides a network-based interface for managing the operational state, settings, and scenes of the software.
• Broadcasting Protocol Integrations - Provides a standardized network API for integrating third-party applications and hardware controllers with OBS Studio.
• Live Stream Output Controls - Enables remote management of live streaming operations, including starting and stopping the output.
• Remote API Command Executions - Allows external devices to trigger specific software actions by sending API-based commands over the network.
• OBS Plugins - Ships as an extension specifically developed for the OBS Studio plugin ecosystem to add remote management.
• Automated Scene Transitions - Triggers transitions between visual compositions using remote signals to set transition type and duration.
• Scene Collection Management - Allows switching between different saved sets of scenes and their associated configurations.
• Scene and Source Control - Allows external applications to switch active scenes and modify the properties of individual sources.
• Live Broadcast Management - Provides tools for controlling real-time video streams, including scene transitions and broadcast operations.
• Broadcast Workflow Automation - Enables automatic triggering of scene transitions and recording actions via external scripts.
• Media Input Source Management - Enables the remote creation, removal, and renaming of multimedia input sources.
• Media Recording Controls - Provides remote controls to start, stop, pause and configure video and audio recording sessions.
• Streaming and Broadcasting - Enables remote adjustment of broadcasting configurations and streaming operations via a network interface.
• WebSocket-Based Application Command Interfaces - Exposes a WebSocket server that accepts structured commands from external clients to control application functions.
• Network Protocols - Implements a consistent network protocol to enable the creation of custom client software and libraries.
• JSON-RPC Implementations - Implements the JSON-RPC protocol for structured, cross-language communication between external clients and the software.
• JSON Serialization - Uses JSON serialization for all network communications to ensure cross-language compatibility.
• Event Stream Subscriptions - Allows clients to subscribe to real-time event streams for automated updates on software state changes.
• Real-Time State Broadcasting - Streams real-time software state changes and system statistics to remote clients via WebSockets.
• Remote Procedure Calls - Implements a remote procedure call mechanism over WebSockets to trigger commands and query state.
• Real-Time State Synchronization - Synchronizes the state of the software with remote clients by pushing real-time updates via network events.
• Scene Hierarchies - Provides remote organization of visual elements into a structured hierarchy of scenes and groups.
• Remote AV Property Management - Allows remote adjustment of volume, routing, and video source properties over a network.
• Workflow Automation Triggers - Supports automated workflows by triggering actions and updating state through event-driven network systems.
• Audio Routing Policies - Allows remote configuration of audio routing policies, including sync offsets and monitor types.
• Audio Volume Controls - Provides remote APIs for adjusting volume levels and mute states of audio sources.
• Virtual Camera Drivers - Toggles a virtual camera driver to stream processed OBS output into other applications.
• Scene Item Properties - Provides remote control of individual scene item transforms, cropping, and blend modes.
• Media Playback Controls - Enables remote control of media playback state, including cursor positions and time offsets.
• Production Control Systems - Functions as a production control system to monitor system statistics and adjust audio-visual properties of a live stream.
• Media Replay Buffers - Manages circular multimedia buffers to save recent broadcast segments as clips on demand.
• Media Source Filters - Allows remote application and configuration of visual and audio processing filters to sources.
• Challenge-Response Authenticators - Secures remote connections using a salted-challenge protocol to verify client identity.
• Third-Party Plugins - Extends the network API by allowing third-party plugins to register custom requests and events.
• Plugin - Routes custom network requests to registered third-party vendor scripts to extend software functionality.
• State Change Monitoring - Tracks and reports real-time changes to scenes, profiles, input states, and output status.
• Server Usage Statistics - Retrieves real-time system statistics, including CPU usage, memory usage, and frames per second.

Star history