Live Transcoding Profiles/FiltersUpdate Transcoding Profile

Update Transcoding Profile

Update stream profile settings. Every field is validated - required-field checks plus the encoding compatibility rules described on each property below - before the profile is updated. Unlike the Create endpoint, no _METHOD override is required for this request.

curl -X POST "https://api.5centscdn.com/v2/streams/settings/profiles/1" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "name": "My 720p Profile",
  "filemode": "hd",
  "f": "mp4",
  "cv": "libx264",
  "sv": "720p",
  "svvalue": "1280x720",
  "svwidth": "1280",
  "svheight": "720",
  "deinterlace": "0",
  "bvvalue": "2500",
  "fps": "30",
  "preset": "veryfast",
  "vprofile": "main",
  "vlevel": "4.0",
  "gop": "2",
  "bframe": "0",
  "tune": "disabled",
  "crf": "ll",
  "ca": "aac",
  "aca": "2",
  "bavalue": "128",
  "ara": "44100"
}'
{
  "result": "success",
  "message": "Transcoding Settings Updated"
}
POST
/streams/settings/profiles/{profileid}
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key (sent in header)

path
profileidstring
Required

Id of the Transcode Profile

Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Name of the transcoding profile. Required; must not be empty or consist only of whitespace.

filemodestring
Required

Stream quality tier. Required.

Options: sd, hd, uhd
fstring
Required

Container format for the output stream. Currently only mp4 is supported. Required together with cv.

Options: mp4
cvstring
Required

Video codec. libx264 = H.264, libx265 = H.265. Only these two codecs are currently supported for live transcoding profiles. Required together with f. The selected codec restricts which vprofile and tune values are valid (see those fields) and, for H.264, also restricts vprofile/vlevel combinations against the codec's macroblocks-per-frame and macroblocks-per-second ceilings for the selected level.

Options: libx264, libx265
svstring

Output resolution preset. Select as_defined to specify a custom resolution via svvalue (and the paired svwidth/svheight inputs).

Options: 2160p, 1440p, 1080p, 720p, 576p, 480p, 360p, 240p, 144p, as_defined
svvaluestring

Custom resolution in WIDTHxHEIGHT format (e.g. 1920x1080). Required and validated only when sv is as_defined: width and height must each be numeric and divisible by 2, width must be between 256 and 7680, height must be between 144 and 4320 (both inclusive), and the combined resolution must not exceed the maximum allowed for the selected cv/vprofile/vlevel combination (see vlevel). Ignored when sv is a fixed preset.

svwidthstring

Width component of the custom resolution, used only when sv is as_defined. Combined with svheight to form svvalue, and subject to the same 256-7680 range, even-number, and codec/profile/level resolution-ceiling rules as svvalue. Sent alongside svvalue and svheight.

svheightstring

Height component of the custom resolution, used only when sv is as_defined. Combined with svwidth to form svvalue, and subject to the same 144-4320 range, even-number, and codec/profile/level resolution-ceiling rules as svvalue. Sent alongside svvalue and svwidth.

deinterlacestring

Deinterlacing toggle. 1 = Yes (enabled), 0 = No (disabled).

Options: 0, 1
bvvaluestring
Required

Video bitrate in kbps. Required; must be numeric and at least 512 - no upper bound applies beyond the per-level bitrate ceiling described under vlevel.

fpsstring

Frames per second. 0 means As Source. The 48, 50, and 60 values are only valid once vlevel is 4.2 or higher, and any value exceeding the maximum FPS allowed for the selected cv/vprofile/vlevel combination is rejected (see vlevel).

Options: 0, 24, 25, 30, 48, 50, 60
presetstring

Encoding speed preset. Faster presets reduce CPU usage but may lower quality.

Options: superfast, veryfast, faster, fast
vprofilestring
Required

Video encoding profile. Required. When cv is libx264, all three options (baseline, main, high) are valid. When cv is libx265, only main is valid - baseline and high are not supported for this codec.

Options: baseline, main, high
vlevelstring
Required

Encoding level. Required. Which levels are valid depends on the chosen cv + vprofile combination: libx264 + baseline allows 3.0, 3.1; libx264 + main allows 3.0, 3.1, 3.2, 4.0, 4.1, 4.2; libx264 + high allows 3.1, 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2; libx265 + main allows 3.0, 3.1, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2. (libx265 + baseline/high are not valid combinations.) Each cv/vprofile/vlevel combination also caps the maximum resolution, video bitrate, and FPS that can be submitted - for example libx264/main/4.0 allows up to 1920x1080 at up to 20000kbps and 30fps, libx264/high/5.1 allows up to 3840x2160 at up to 240000kbps and 30fps, and libx265/main/5.0 allows up to 3840x2160 at up to 100000kbps and 60fps; resolution, bitrate, or fps values above the selected level's ceiling are rejected. For libx264 specifically, an additional macroblocks-per-frame and macroblocks-per-second ceiling for the selected level also applies.

Options: 3.0, 3.1, 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2
gopstring

Group of Pictures (keyframe) interval in seconds. Not applicable while fps is 0 (As Source), in which case the existing value is retained. If provided, must be numeric; a gop x fps value below 30 frames or above 300 frames is not recommended.

Options: 2, 4, 6, 8, 10, 12
bframestring

Number of consecutive B-frames used in encoding. This value is not currently configurable and is carried through unchanged from the existing profile.

tunestring

Encoding tune. Available options depend on cv: libx264 allows disabled, zerolatency, fastdecode; libx265 allows disabled, fastdecode only (no zerolatency). Only disabled is available unless the account has the Advanced Features add-on enabled.

Options: disabled, zerolatency, fastdecode
crfstring

Internal CRF quality flag. Not currently configurable; always submitted with the default value ll.

castring
Required

Audio codec. Only aac is currently supported. Required.

Options: aac
acastring
Required

Audio channel configuration. 0 = As Source, 1 = Stereo, 2 = Mono. Required.

Options: 0, 1, 2
bavaluestring
Required

Audio bitrate in kbps. Required; must be numeric, at least 32, and no more than 320.

arastring
Required

Audio sample rate in Hz. Required.

Options: 48000, 44100, 32000, 22050, 16000
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. Provide your API key in the header.

Path Parameters

profileidstring
Required

Id of the Transcode Profile

Example:
1

Body

application/json
namestring
Required

Name of the transcoding profile. Required; must not be empty or consist only of whitespace.

Example:
My 720p Profile
filemodestring
Required

Stream quality tier. Required.

Allowed values:sdhduhd
fstring
Required

Container format for the output stream. Currently only mp4 is supported. Required together with cv.

Allowed values:mp4
cvstring
Required

Video codec. libx264 = H.264, libx265 = H.265. Only these two codecs are currently supported for live transcoding profiles. Required together with f. The selected codec restricts which vprofile and tune values are valid (see those fields) and, for H.264, also restricts vprofile/vlevel combinations against the codec's macroblocks-per-frame and macroblocks-per-second ceilings for the selected level.

Allowed values:libx264libx265
svstring

Output resolution preset. Select as_defined to specify a custom resolution via svvalue (and the paired svwidth/svheight inputs).

Allowed values:2160p1440p1080p720p576p480p360p240p144pas_defined
svvaluestring

Custom resolution in WIDTHxHEIGHT format (e.g. 1920x1080). Required and validated only when sv is as_defined: width and height must each be numeric and divisible by 2, width must be between 256 and 7680, height must be between 144 and 4320 (both inclusive), and the combined resolution must not exceed the maximum allowed for the selected cv/vprofile/vlevel combination (see vlevel). Ignored when sv is a fixed preset.

Example:
1280x720
svwidthstring

Width component of the custom resolution, used only when sv is as_defined. Combined with svheight to form svvalue, and subject to the same 256-7680 range, even-number, and codec/profile/level resolution-ceiling rules as svvalue. Sent alongside svvalue and svheight.

Example:
1280
svheightstring

Height component of the custom resolution, used only when sv is as_defined. Combined with svwidth to form svvalue, and subject to the same 144-4320 range, even-number, and codec/profile/level resolution-ceiling rules as svvalue. Sent alongside svvalue and svwidth.

Example:
720
deinterlacestring

Deinterlacing toggle. 1 = Yes (enabled), 0 = No (disabled).

Allowed values:01
bvvaluestring
Required

Video bitrate in kbps. Required; must be numeric and at least 512 - no upper bound applies beyond the per-level bitrate ceiling described under vlevel.

Example:
2500
fpsstring

Frames per second. 0 means As Source. The 48, 50, and 60 values are only valid once vlevel is 4.2 or higher, and any value exceeding the maximum FPS allowed for the selected cv/vprofile/vlevel combination is rejected (see vlevel).

Allowed values:0242530485060
presetstring

Encoding speed preset. Faster presets reduce CPU usage but may lower quality.

Allowed values:superfastveryfastfasterfast
vprofilestring
Required

Video encoding profile. Required. When cv is libx264, all three options (baseline, main, high) are valid. When cv is libx265, only main is valid - baseline and high are not supported for this codec.

Allowed values:baselinemainhigh
vlevelstring
Required

Encoding level. Required. Which levels are valid depends on the chosen cv + vprofile combination: libx264 + baseline allows 3.0, 3.1; libx264 + main allows 3.0, 3.1, 3.2, 4.0, 4.1, 4.2; libx264 + high allows 3.1, 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2; libx265 + main allows 3.0, 3.1, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2. (libx265 + baseline/high are not valid combinations.) Each cv/vprofile/vlevel combination also caps the maximum resolution, video bitrate, and FPS that can be submitted - for example libx264/main/4.0 allows up to 1920x1080 at up to 20000kbps and 30fps, libx264/high/5.1 allows up to 3840x2160 at up to 240000kbps and 30fps, and libx265/main/5.0 allows up to 3840x2160 at up to 100000kbps and 60fps; resolution, bitrate, or fps values above the selected level's ceiling are rejected. For libx264 specifically, an additional macroblocks-per-frame and macroblocks-per-second ceiling for the selected level also applies.

Allowed values:3.03.13.24.04.14.25.05.15.2
gopstring

Group of Pictures (keyframe) interval in seconds. Not applicable while fps is 0 (As Source), in which case the existing value is retained. If provided, must be numeric; a gop x fps value below 30 frames or above 300 frames is not recommended.

Allowed values:24681012
bframestring

Number of consecutive B-frames used in encoding. This value is not currently configurable and is carried through unchanged from the existing profile.

Example:
0
tunestring

Encoding tune. Available options depend on cv: libx264 allows disabled, zerolatency, fastdecode; libx265 allows disabled, fastdecode only (no zerolatency). Only disabled is available unless the account has the Advanced Features add-on enabled.

Allowed values:disabledzerolatencyfastdecode
crfstring

Internal CRF quality flag. Not currently configurable; always submitted with the default value ll.

Example:
ll
castring
Required

Audio codec. Only aac is currently supported. Required.

Allowed values:aac
acastring
Required

Audio channel configuration. 0 = As Source, 1 = Stereo, 2 = Mono. Required.

Allowed values:012
bavaluestring
Required

Audio bitrate in kbps. Required; must be numeric, at least 32, and no more than 320.

Example:
128
arastring
Required

Audio sample rate in Hz. Required.

Allowed values:4800044100320002205016000

Responses

resultstring

Status of the API response.

messagestring

Human-readable message describing the result.