Transcode Preset Update
Updates an existing transcoding preset.
Request
| Property | Value |
|---|---|
| Method | PUT |
| URL | /api/transcode/settings/presets/{presetId} |
| Content-Type | application/json |
| Authentication | Bearer Token |
Request
curl -X PUT "{BASE_URL}/api/transcode/settings/presets/{presetId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
presetId | integer | Yes | Unique identifier of the preset |
Request with parameters
curl -X PUT "{BASE_URL}/api/transcode/settings/presets/{presetId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
data.attributes.name | string | Yes | Preset name |
data.attributes.suffix | string | Yes | Stream key suffix for transcoded output |
data.attributes.video | object | Yes | Video encoder configuration |
data.attributes.audio | object | Yes | Audio encoder configuration |
Request body
{
"data": {
"attributes": {
"name": "720p_updated",
"suffix": "_720p",
"video": {
"encoder": "libx264",
"profile": "main",
"bitrate": 3000,
"frameRate": 30,
"keyFrameInterval": 30,
"preset": "ultrafast",
"tune": "zerolatency",
"height": 720
},
"audio": {
"encoder": "aac",
"channels": 2,
"bitrate": 160,
"sampleRate": 44100
}
}
}
}
Response Body
Preset Object
| Parameter | Type | Description |
|---|---|---|
data.id | integer | Unique identifier of the preset |
data.attributes.name.value | string | Preset name |
data.attributes.name.editable | boolean | Indicates if the field can be modified |
data.attributes.suffix.value | string | Stream key suffix for transcoded output |
data.attributes.suffix.editable | boolean | Indicates if the field can be modified |
message | string | Response status message |
Video Settings
| Parameter | Type | Description |
|---|---|---|
data.attributes.video.encoder.value | string | Video encoder |
data.attributes.video.encoder.editable | boolean | Indicates if the field can be modified |
data.attributes.video.width.value | integer | null | Output video width |
data.attributes.video.width.editable | boolean | Indicates if the field can be modified |
data.attributes.video.height.value | integer | null | Output video height |
data.attributes.video.height.editable | boolean | Indicates if the field can be modified |
data.attributes.video.bitrate.value | integer | Video bitrate in kbps |
data.attributes.video.bitrate.editable | boolean | Indicates if the field can be modified |
data.attributes.video.frameRate.value | integer | Output frame rate |
data.attributes.video.frameRate.editable | boolean | Indicates if the field can be modified |
data.attributes.video.keyFrameInterval.value | integer | Keyframe interval in frames |
data.attributes.video.keyFrameInterval.editable | boolean | Indicates if the field can be modified |
data.attributes.video.profile.value | string | H.264 profile |
data.attributes.video.profile.editable | boolean | Indicates if the field can be modified |
data.attributes.video.preset.value | string | Encoder preset |
data.attributes.video.preset.editable | boolean | Indicates if the field can be modified |
data.attributes.video.tune.value | string | Encoder tuning |
data.attributes.video.tune.editable | boolean | Indicates if the field can be modified |
Audio Settings
| Parameter | Type | Description |
|---|---|---|
data.attributes.audio.encoder.value | string | Audio encoder |
data.attributes.audio.encoder.editable | boolean | Indicates if the field can be modified |
data.attributes.audio.codec.value | string | Audio codec |
data.attributes.audio.codec.editable | boolean | Indicates if the field can be modified |
data.attributes.audio.bitrate.value | integer | Audio bitrate in kbps |
data.attributes.audio.bitrate.editable | boolean | Indicates if the field can be modified |
data.attributes.audio.sampleRate.value | integer | Audio sample rate in Hz |
data.attributes.audio.sampleRate.editable | boolean | Indicates if the field can be modified |
data.attributes.audio.channels.value | integer | Number of audio channels |
data.attributes.audio.channels.editable | boolean | Indicates if the field can be modified |
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)
{
"data": {
"id": 3,
"attributes": {
"name": {
"editable": true,
"value": "720p_updated"
},
"suffix": {
"editable": true,
"value": "_720p"
},
"video": {
"encoder": {
"editable": false,
"value": "libx264"
},
"width": {
"editable": true,
"value": null
},
"height": {
"editable": true,
"value": 720
},
"bitrate": {
"editable": true,
"value": 3000
},
"frameRate": {
"editable": true,
"value": 30
},
"keyFrameInterval": {
"editable": true,
"value": 30
},
"profile": {
"editable": true,
"value": "main"
},
"preset": {
"editable": true,
"value": "ultrafast"
},
"tune": {
"editable": true,
"value": "zerolatency"
}
},
"audio": {
"encoder": {
"editable": false,
"value": "aac"
},
"codec": {
"editable": false,
"value": "AAC"
},
"channels": {
"editable": true,
"value": 2
},
"bitrate": {
"editable": true,
"value": 160
},
"sampleRate": {
"editable": true,
"value": 44100
}
}
}
},
"meta": {
"executionTime": 55,
"generatedAt": 1765799971062
},
"message": "Preset has been updated"
}
Error Responses
| Parameter | Type | Description |
|---|---|---|
message | string | Human-readable error message |
Preset Not Found (404)
{
"message": "Transcode Preset Entity not found"
}
Encoders
See Transcode Preset Create for available video and audio encoder configurations.
Support Needed?
Create a free ticket and our support team will provide you necessary assistance.