Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red5 Pro WebRTC SDK

The Red5 Pro WebRTC SDK is a JavaScript library for integrating low-latency live streaming publish and subscribe capabilities into web applications. It supports WHIP for WebRTC publishing and WHEP for WebRTC playback, enabling sub-second latency streaming directly in the browser without plugins. The SDK provides APIs for managing stream sessions, configuring media constraints, handling connection lifecycle events, and interacting with Stream Manager for scalable deployments.

Red5 Pro WebRTC SDK is one of 17 APIs that Red5 publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include JavaScript, Media, SDK, Streaming, and WebRTC. The published artifact set on APIs.io includes API documentation, an API reference, and an AsyncAPI specification.

This event API exposes 4 operations across 2 channels, and defines 11 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, wss://{host}:443/live/{streamName} (wss).

4 operations 2 channels 11 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Base URL
https://api.example.com
Resource Areas
1

Channels & Operations 4

Across 2 channels, the API surfaces 4 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 4
SUB
/publish
Publisher receives signaling message from server
publisherReceive body
PUB
/publish
Publisher sends signaling message to server
publisherSend body
SUB
/subscribe
Subscriber receives signaling message from server
subscriberReceive body
PUB
/subscribe
Subscriber sends signaling message to server
subscriberSend body

Messages & Schemas 11

The contract defines 11 schemas that model the data carried by its messages. The most detailed are StreamEventPayload (5 properties), PublishRequestPayload (5 properties), IceCandidatePayload (4 properties), SdpPayload (2 properties). Each schema is shown below with its type and property counts.

PublishRequest
message
Initial request from a publisher to start a streaming session
SubscribeRequest
message
Initial request from a subscriber to join a streaming session
SdpOffer
message
WebRTC SDP offer from a client
SdpAnswer
message
WebRTC SDP answer from the server
IceCandidate
message
ICE candidate for WebRTC peer connection establishment
StreamEvent
message
Server-sent event about stream state changes
PublishRequestPayload
object
Payload for initiating a WebRTC publish session
5 properties 2 required
SubscribeRequestPayload
object
Payload for initiating a WebRTC subscribe session
2 properties 2 required
SdpPayload
object
WebRTC Session Description Protocol message payload
2 properties 2 required
IceCandidatePayload
object
WebRTC ICE candidate message payload
4 properties 2 required
StreamEventPayload
object
Server-sent stream lifecycle event payload
5 properties 2 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

red5-webrtc-streaming-asyncapi.yml Raw ↑

Other APIs Red5 publishes across the network.

Red5 Pro Server API
Red5 Core SDK
Red5 Pro iOS Streaming SDK
Red5 Pro Android Streaming SDK
Red5 Admin API
Red5 Applications API
Red5 File Restreamer API
Red5 Images API
Red5 Inputs API
Red5 Logs API
Red5 Mixers API
Red5 Provision API