RelayrtcDocs
Get started
Documentation
Streaming

Streaming ingest

Publish from a room, an RTMP encoder or a WHIP client.

On this page

Choose a source when creating the stream. ROOM uses existing RTC publications; WHIP and RTMP use short-lived encoder credentials. For deployment and SDK prerequisites, see live streaming.

Room sources

Create a room in the same project and environment, join it through your application's token flow, and publish the desired tracks. Then create a stream with source: { kind: 'room', roomId } and call streams.start(streamId) on your backend.

Optional videoTrackIds and audioTrackIds restrict selection to tracks belonging to that room. They are not credentials. Start participants' capture through explicit device controls; creating a stream does not activate cameras or microphones.

RTMP and WHIP credentials

This server helper creates an RTMP stream and one credential. Change kind to whip for a WHIP publisher.

TypeScript
import { relay } from './relay.js'
 
export async function createEncoderStream() {
  const stream = await relay.streams.create({
    name: 'Studio encoder',
    source: { kind: 'rtmp' },
  })
  const credential = await relay.streams.createIngestCredentials(stream.id, {
    ttlSeconds: 3600,
  })
  return { stream, credential }
}

Return the credential only to an authorized publisher. secret is shown on creation or rotation; listing credentials returns the latest 50 records without secrets. Credentials default to one hour and accept 60–86400 seconds. At most five active credentials can exist for a stream.

Connect an RTMP encoder

Use the returned URL as the complete ingest path. If the encoder separates Server and Stream Key, split the URL into its origin and path. Authenticate with username publisher and the returned secret as password. For clients using URL authentication, supply the gateway's user=publisher and pass query parameters with properly encoded values.

Send H.264 video and AAC audio. A second simultaneous publisher is rejected. RTMPS requires a deployment gateway with a trusted TLS certificate; an RTMP URL is not encrypted merely because the API uses HTTPS.

Once the encoder connects, RelayRTC starts the source session. Do not call the ROOM source start workflow for an external encoder.

Connect a WHIP publisher

POST the SDP offer to the returned URL with Authorization: Bearer <secret>. A successful response contains the SDP answer and a Location for that publishing session. Use the returned session URL and applicable ETag/ICE headers for supported trickle-ICE PATCH requests, and DELETE the session URL when leaving.

Offer bodies are limited to 128 KiB. Browser origins must be explicitly allowed by the deployment. Continue authenticating session operations with the current credential. WHIP ingest does not imply WHEP playback or SRT ingest support.

Rotate and reconnect

Rotation revokes the old credential and disconnects its publisher. The response includes handover with a ready or pending status and retryAfterSeconds. Wait as instructed, then reconnect the encoder using the new URL and secret. Rotation does not migrate an active encoder connection automatically.

Inspect streams.getPlayback(streamId) after connecting. publisherConnected, sourceProducing and viewerReady describe different stages. Check its safe readiness code or the source session's lastError when connection succeeds but playback does not.

Continue with broadcast runs or private HLS playback. Exact methods are in the stream API reference.