Playcast API Reference

Comprehensive documentation for Playcast's streaming, messaging, WebRTC, and game capture APIs. Build powerful interactive experiences with our developer-friendly APIs.

50+
API Endpoints
200+
Type Definitions
15+
Message Types
5
Core Libraries

Messaging API

Real-time messaging system with WebSocket support for game events, input handling, and peer communication.

  • PlaycastMessage Type
  • WebSocket Messages WS
  • Message Validators Function
  • Message Generators Function
Explore Messaging API

WebRTC API

Peer-to-peer communication, video streaming, and real-time data channels for interactive gaming experiences.

  • PeerConnection Class
  • Quality Management Function
  • Media Tracks Function
  • Statistics Function
Explore WebRTC API

Authentication API

Secure authentication with JWT tokens, session management, and Clerk integration for user management.

  • Login Token POST
  • Validate Token POST
  • Refresh Session POST
  • Session Management Function
Explore Auth API

Playjector API

Game capture and control bridge for communicating with the native C++ Playjector application via TCP sockets.

  • Connection Management Function
  • Process Spawning Function
  • Message Handling Function
  • Auto-Reconnect Function
Explore Playjector API

Type Definitions

Comprehensive TypeScript type definitions for all Playcast APIs, ensuring type safety across your application.

  • Core Types Type
  • Message Types Type
  • Peer Types Type
  • User Types Type
Explore Types

Quick Start

Get started with Playcast APIs in minutes. Choose your integration path:

WebRTC Streaming

Set up peer-to-peer video streaming with quality management.

Start Streaming →

Real-time Messaging

Implement real-time communication with WebSocket messages.

Send Messages →

User Authentication

Secure your application with JWT tokens and session management.

Authenticate Users →

Game Integration

Connect to the Playjector for game capture and control.

Capture Games →