place.stream.playback.whep

Lexicon Version: 1

Definitions

main

Type: procedure

Play a stream over WebRTC using WHEP.

Parameters:

Name	Type	Req’d	Description	Constraints
streamer	string	✅	The DID of the streamer to play.
rendition	string	✅	The rendition of the stream to play.

Input:

• Encoding: */*
• Schema:

Schema not defined. Output:

• Encoding: */*
• Schema:

Schema not defined. Possible Errors:

• Unauthorized: This user may not play this stream.

---

Lexicon Source

{
  "lexicon": 1,
  "id": "place.stream.playback.whep",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Play a stream over WebRTC using WHEP.",
      "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."
          }
        }
      },
      "input": {
        "encoding": "*/*"
      },
      "output": {
        "encoding": "*/*"
      },
      "errors": [
        {
          "name": "Unauthorized",
          "description": "This user may not play this stream."
        }
      ]
    }
  }
}