minimusdocs
Help center

Streams

Preview a stream

POST/streams/{id}/preview/

write Change: creates or edits. Scopes

A short-lived address to watch the stream yourself, even when it is not running (a server starts it for you). It counts as a viewer under your own name until you close it with DELETE. Optional convert (audio or video) asks the server to convert what a browser cannot play; plays, the codec families the player handles, lets the panel decide. A stream sent straight from its source answers direct: true and the source address.

Path parameters

  • idstring (uuid)required

    The stream's id.

Body

  • convertstring
    • audio - audio
    • video - video

    One of: "audio" "video"

  • playsstring[]

    Codec families the player handles, e.g. ["h264", "aac"].

Response

200 OK

  • directbooleanrequired
  • urlstringrequired
  • session_idstring
  • video_codecstring
  • audio_codecstring
  • transcodedboolean

    A transcoding profile changes the picture.

  • convertstringcan be null
  • convert_refusedstring

    Why it cannot convert now.

  • expires_ininteger

    Seconds the address works.

  • serverstring
  • startingboolean

    Not running yet: allow for a start.

  • stops_on_closeboolean
  • detailstring

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 The stream has no working source.
  • 409 The stream is turned off.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.
  • 503 No streaming server can play it now.

What each error means