Transcode Settings Update

Updates the transcode configuration settings.

Request

Property	Value
Method	`PATCH`
URL	`/api/transcode/settings`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X PATCH "{BASE_URL}/api/transcode/settings" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Request Body

Parameter	Type	Required	Description
`data.attributes.ffmpegPath`	string	No	Path to the ffmpeg executable
`data.attributes.ffmpegCommand`	string	No	FFmpeg command template with placeholders
`data.attributes.transcodeTaskLimit`	integer \| null	No	Maximum number of concurrent transcode tasks
`data.attributes.thumbGenerateTaskLimit`	integer \| null	No	Maximum number of concurrent thumbnail generation tasks

Example Request

Example Request (Update FFmpeg Command)

json

{
  "data": {
    "attributes": {
      "ffmpegPath": "ffmpeg",
      "transcodeTaskLimit": 5,
      "thumbGenerateTaskLimit": 2
    }
  }
}

json

{
  "data": {
    "attributes": {
      "transcodeTaskLimit": null
    }
  }
}

Response Body

Transcode Settings

Parameter	Type	Description
`data.attributes.ffmpegPath.value`	string	Path to the ffmpeg executable
`data.attributes.ffmpegPath.editable`	boolean	Indicates if the field can be modified
`data.attributes.ffmpegPath.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.ffmpegCommand.value`	string	FFmpeg command template with placeholders
`data.attributes.ffmpegCommand.editable`	boolean	Indicates if the field can be modified
`data.attributes.ffmpegCommand.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.transcodeTaskLimit.value`	integer \| null	Maximum number of concurrent transcode tasks
`data.attributes.transcodeTaskLimit.editable`	boolean	Indicates if the field can be modified
`data.attributes.transcodeTaskLimit.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.thumbGenerateTaskLimit.value`	integer \| null	Maximum number of concurrent thumbnail generation tasks
`data.attributes.thumbGenerateTaskLimit.editable`	boolean	Indicates if the field can be modified
`data.attributes.thumbGenerateTaskLimit.lockedBy`	string	Locked by environment variable (if present)
`message`	string	Response status message

FFmpeg Command Placeholders

Placeholder	Description
`{SOURCE_INPUT}`	Source stream input URL
`{VIDEO_ENCODER}`	Video encoder
`{AUDIO_ENCODER}`	Audio encoder
`{STREAM_OUTPUT}`	Output stream destination URL

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "attributes": {
      "ffmpegPath": {
        "editable": true,
        "value": "ffmpeg"
      },
      "ffmpegCommand": {
        "editable": true,
        "value": "-re -nostdin -i {SOURCE_INPUT} {VIDEO_ENCODER} {AUDIO_ENCODER} -f flv {STREAM_OUTPUT}"
      },
      "transcodeTaskLimit": {
        "editable": true,
        "value": null
      },
      "thumbGenerateTaskLimit": {
        "editable": true,
        "value": 2
      }
    }
  },
  "meta": {
    "executionTime": 55,
    "generatedAt": 1765791753570
  },
  "message": "Transcode Settings updated"
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.