minimusdocs
Help center

Sources

Update a source

PATCH/streams/sources/{id}/

write Change: creates or edits. Scopes

Path parameters

  • idstring (uuid)required

    The source's id.

Body

  • namestring
  • urlstring (uri)
  • is_activeboolean
  • qualitystringcan be null

    e.g., 720p, 1080p, 4K

  • bitrateintegercan be null

    Bitrate in kbps

Response

200 OK

  • idstring (uuid)requiredread-only
  • namestringrequired
  • urlstring (uri)required
  • is_activeboolean
  • qualitystringcan be null

    e.g., 720p, 1080p, 4K

  • bitrateintegercan be null

    Bitrate in kbps

  • healthstringrequiredread-only

    How the servers last found it: online while a server plays from it, down after one failed to, unknown until a server has tried.

  • health_atstring (date-time)requiredread-onlycan be null

    When a server last said how it found it.

  • probed_video_codecstringrequiredread-only

    e.g. h264, hevc. Empty until a server has read the source.

  • probed_audio_codecstringrequiredread-only
  • probed_fpsnumberrequiredread-onlycan be null

    Null when the source declares a variable or unknown rate.

  • probed_widthintegerrequiredread-onlycan be null
  • probed_heightintegerrequiredread-onlycan be null
  • probed_audio_tracksintegerrequiredread-onlycan be null

    Number of audio streams — language alternatives.

  • probed_atstring (date-time)requiredread-onlycan be null

    When a server last read these, as a stream started on it.

  • streams_countintegerrequiredread-only

    How many streams read from it.

  • created_bystring (uuid)requiredread-onlycan be null
  • created_by_usernamestringrequiredread-only
  • created_atstring (date-time)requiredread-only
  • updated_atstring (date-time)requiredread-only

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 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means