Documentation Index
Fetch the complete documentation index at: https://na-36-handover-docs-v2-into-docs-v2-dev-20260518.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Livepeer accepts live video via RTMP. A stream object holds the ingest configuration, transcoding profiles, and generates the HLS playback URL. The stream key embedded in the ingest URL authenticates the push; only a client with the correct key can publish to that stream.
Stream Creation
Create a stream via the SDK:Pushing a Stream
Point OBS to the ingest URL and stream key:- Server:
rtmp://rtmp.livepeer.com/live - Stream Key: value of
stream.streamKey
Transcoding Profiles
Each profile in theprofiles array defines one output rendition. The Livepeer network transcodes the ingest stream into each requested profile in parallel.
Profile fields:
| Field | Type | Description |
|---|---|---|
name | string | Label for this rendition (e.g. 720p) |
bitrate | integer | Target video bitrate in bits per second |
fps | integer | Output frames per second |
width | integer | Output width in pixels |
height | integer | Output height in pixels |
profile | string | H.264 encoder profile: H264Baseline, H264Main, H264High, H264ConstrainedHigh |
gop | string | GOP length in seconds, or "intra" for all-intra |
stream.playbackUrl lists all renditions. ABR players select the appropriate rendition based on available bandwidth.
Stream Events
Livepeer fires webhooks on stream lifecycle events. Subscribe to events when creating a stream:| Event | Fires when |
|---|---|
stream.started | First RTMP frame received; transcoding begins |
stream.idle | No RTMP data for 60 seconds |
stream.recording.ready | Recording asset is ready (if record: true) |
All webhook payloads are signed with an HMAC-SHA256 signature using your webhook secret. Verify the
Livepeer-Signature header before processing events.Related Pages
VOD
Upload and transcode video-on-demand assets via the same SDK.
Video Overview
Access paths and workload comparison for Livepeer video.
Transcoding
Direct transcoding for applications managing their own segments.
Player
Embed the @livepeer/react Player component to play back HLS streams.