place.stream.playback.whep Documentation (EN)

main procedure

Play a stream over WebRTC using WHEP.

Parameters

rendition string Required

The rendition of the stream to play.

streamer string Required

The DID of the streamer to play.

Input

Encoding*/*

Output

Encoding*/*

Errors

Unauthorized This user may not play this stream.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": null,
    "encoding": "*/*"
  },
  "errors": [
    {
      "name": "Unauthorized",
      "description": "This user may not play this stream."
    }
  ],
  "output": {
    "schema": null,
    "encoding": "*/*"
  },
  "parameters": {
    "type": "params",
    "required": [
      "streamer",
      "rendition"
    ],
    "properties": {
      "streamer": {
        "type": "string",
        "description": "The DID of the streamer to play."
      },
      "rendition": {
        "type": "string",
        "description": "The rendition of the stream to play."
      }
    }
  },
  "description": "Play a stream over WebRTC using WHEP."
}