minimusdocs
Help center

Transcoding profiles

Update a transcoding profile

PATCH/streams/transcoding-profiles/{id}/

write Change: creates or edits. Scopes

Built-in profiles (is_system) can be edited but not deleted.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Transcoding Profile.

Body

  • namestring

    Display name (e.g. SD, HD, FHD).

  • descriptionstring
  • video_codecstring
    • h264 - H.264

    One of: "h264"

  • audio_codecstring
    • aac - AAC
    • mp3 - MP3
    • copy - Copy (no re-encode)

    One of: "aac" "mp3" "copy"

  • widthinteger

    Output frame width in pixels (e.g. 1280).

  • heightinteger

    Output frame height in pixels (e.g. 720).

  • fpsinteger

    Output frame rate. Use 30 for TV unless the source is 60fps.

  • video_bitrateinteger

    Video bitrate ceiling in kbps (encoder uses less for quiet scenes).

  • audio_bitrateinteger

    Audio bitrate in kbps.

  • keyframe_intervalinteger

    Keyframe interval in frames. 30 ≈ 1s at 30fps.

  • presetstring

    Encoder speed preset (only honoured by software x264enc).

    • ultrafast - Ultrafast
    • superfast - Superfast
    • veryfast - Veryfast
    • faster - Faster
    • fast - Fast
    • medium - Medium
  • qualityinteger

    Quantizer / CRF. 18-28 sane range; 22 ≈ transparent.

Response

200 OK

  • idstring (uuid)requiredread-only
  • namestringrequired

    Display name (e.g. SD, HD, FHD).

  • descriptionstring
  • video_codecstring
    • h264 - H.264

    One of: "h264"

  • audio_codecstring
    • aac - AAC
    • mp3 - MP3
    • copy - Copy (no re-encode)

    One of: "aac" "mp3" "copy"

  • widthintegerrequired

    Output frame width in pixels (e.g. 1280).

  • heightintegerrequired

    Output frame height in pixels (e.g. 720).

  • resolutionstringrequiredread-only
  • fpsinteger

    Output frame rate. Use 30 for TV unless the source is 60fps.

  • video_bitrateintegerrequired

    Video bitrate ceiling in kbps (encoder uses less for quiet scenes).

  • audio_bitrateinteger

    Audio bitrate in kbps.

  • keyframe_intervalinteger

    Keyframe interval in frames. 30 ≈ 1s at 30fps.

  • presetstring

    Encoder speed preset (only honoured by software x264enc).

    • ultrafast - Ultrafast
    • superfast - Superfast
    • veryfast - Veryfast
    • faster - Faster
    • fast - Fast
    • medium - Medium
  • qualityinteger

    Quantizer / CRF. 18-28 sane range; 22 ≈ transparent.

  • is_systembooleanrequiredread-only

    System-seeded profile. Operators should clone instead of editing.

  • 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