minimusdocs
Help center

Transcoding profiles

List transcoding profiles

GET/streams/transcoding-profiles/

read Read: looks, changes nothing. Scopes

How a stream's picture and sound are converted when it is not sent as it is. Built-in profiles (is_system) can be edited but not deleted.

Query parameters

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • 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

  • 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.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means