Live Transcoding Profiles/FiltersUpdate Transcoding Profile

Update Transcoding Profile

update stream profiles setting

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 '{
  "_METHOD": "PUT",
  "name": "My 720p Profile",
  "filemode": "single",
  "outdir": "/output/videos",
  "sourceaudio": "",
  "sourcevideo": "",
  "f": "mp4",
  "hlsUnifiedSegments": false,
  "hlsfMP4Segments": false,
  "cv": "libx264",
  "sv": "720p",
  "svvalue": "1280x720",
  "crfv": "24",
  "kar": "0",
  "ol": "0",
  "bv": "1",
  "bvvalue": "2500",
  "vpass": "1",
  "vprofile": "main",
  "vlevel": "4.0",
  "fps": "30",
  "gop": "6",
  "preset": "veryfast",
  "tune": "disabled",
  "bframe": "1",
  "upscale": "Y",
  "ca": "aac",
  "aca": "2",
  "ba": "1",
  "bavalue": "128",
  "ara": "44100",
  "tm": "disabled",
  "tv": "00:00:05",
  "filters": [],
  "profiles": []
}'
{
  "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
_METHODstring
Required

HTTP method override. Must be set to PUT to perform an update operation.

namestring
Required

Name of the transcoding profile.

filemodestring

Profile mode. single encodes the file to one output; combined bundles multiple sub-profiles. Allowed values: single, combined.

outdirstring

Output directory path where encoded files are stored.

sourceaudiostring

Source audio stream identifier used during encoding.

sourcevideostring

Source video stream identifier used during encoding.

fstring

Container format for the output file. Allowed values: mp4, webm, hls, hlsaes. webm requires VP9 or AV1 codec. hls and hlsaes convert to HLS segments and manifest.

hlsUnifiedSegmentsboolean

Applicable only when f is hls or hlsaes. When true, audio and video are embedded in the same HLS segments. Enable if compatibility issues occur or when the source has multiple audio tracks (only the first audio track will be encoded).

hlsfMP4Segmentsboolean

Applicable only when f is hls or hlsaes. When true, fMP4 (fragmented MP4) segments are used instead of the default MPEG-TS segments.

cvstring

Video codec. libx264 = H.264, libx265 = H.265, libvpx-vp9 = VP9 (webm only), libaom-av1 = AV1 (advanced feature). Allowed values: libx264, libx265, libvpx-vp9, libaom-av1.

svstring

Output resolution preset. Use as_defined to specify a custom resolution via svvalue. 0 means As Source. Allowed values: 2160p, 1440p, 1080p, 720p, 576p, 480p, 360p, 240p, 144p, 0, as_defined.

svvaluestring

Custom resolution in WIDTHxHEIGHT format. Required when sv is as_defined. Width range 256–7680, height range 144–4320, both values must be divisible by 2.

crfvstring

Constrained Quality factor controlling quality vs file size. 18 = High quality, 24 = Medium quality, 28 = Low quality. Allowed values: 18, 24, 28.

karstring

Keep Aspect Ratio. When set to 1, only height is fixed and width adjusts automatically to preserve the source aspect ratio. Allowed values: 0, 1.

olstring

Orientation Lock. When set to 1, the landscape or portrait orientation of the source video is preserved. Allowed values: 0, 1.

bvstring

Video bitrate mode. 0 = As Source (copy source bitrate), 1 = As Defined (use custom bvvalue). Allowed values: 0, 1.

bvvaluestring

Custom video bitrate in kbps. Required when bv is 1.

vpassstring

Number of encoding passes. 1 = One Pass, 2 = Two Pass. Disabled when bv is 0. Allowed values: 1, 2.

vprofilestring

Video encoding profile. H.264 (libx264) supports baseline, main, high. H.265 (libx265) supports main, main10. VP9 (libvpx-vp9) supports profile0, profile2. AV1 (libaom-av1) supports main. Allowed values: baseline, main, high, main10, profile0, profile2.

vlevelstring

Encoding level defining resolution and bitrate constraints. Available levels depend on codec and profile selection. Allowed values: 3.0, 3.1, 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2, 6.0, 6.1, 6.2.

fpsstring

Frames per second. 0 means As Source. Allowed values: 0, 24, 25, 30, 48, 50, 60.

gopstring

Group of Pictures (keyframe) interval in seconds. Left empty when fps is 0. Allowed values: 2, 4, 6, 8, 10, 12.

presetstring

Encoding speed preset controlling compression efficiency and CPU usage. Faster presets use less CPU but may reduce quality. Allowed values: superfast, veryfast, faster, fast, medium, slow.

tunestring

Encoding tune to optimise for specific content or use case. H.264 supports disabled, film, animation, grain, stillimage, fastdecode. H.265 supports disabled, fastdecode. VP9 and AV1 support disabled only. Allowed values: disabled, film, animation, grain, stillimage, fastdecode.

bframestring

Number of consecutive B-frames used in encoding. Higher values improve compression efficiency but increase encoding latency. Allowed values: 0, 1, 2, 3, 4.

upscalestring

Video upscaling. Y = Allow upscaling when source resolution is lower than the target. N = Disallow upscaling. Allowed values: Y, N.

castring

Audio codec. copy = As Source (pass-through). aac and libmp3lame are for mp4, hls, hlsaes containers. libopus is for webm only. Allowed values: copy, aac, libmp3lame, libopus.

acastring

Audio channel configuration. 0 = As Source, 1 = Mono, 2 = Stereo. Allowed values: 0, 1, 2.

bastring

Audio bitrate mode. 0 = As Source, 1 = As Defined (use custom bavalue). As Source is not available for webm. Allowed values: 0, 1.

bavaluestring

Audio bitrate in kbps. Required when ba is 1.

arastring

Audio sample rate. 0 = As Source. Allowed values: 0, 44100, 48000.

tmstring

Thumbnail generation mode. disabled = no thumbnails, fixed = capture once at time tv, interval = capture repeatedly at tv interval, sprite = generate sprite sheet. Allowed values: disabled, fixed, interval, sprite.

tvstring

Time value for thumbnail capture in HH:MM:SS format. Required when tm is fixed or interval.

filtersarray

Array of filter names to apply to the encoding output.

profilesarray

Array of sub-profile configurations. Applicable when filemode is combined.

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
_METHODstring
Required

HTTP method override. Must be set to PUT to perform an update operation.

Example:
PUT
namestring
Required

Name of the transcoding profile.

Example:
My 720p Profile
filemodestring

Profile mode. single encodes the file to one output; combined bundles multiple sub-profiles. Allowed values: single, combined.

Example:
single
outdirstring

Output directory path where encoded files are stored.

Example:
/output/videos
sourceaudiostring

Source audio stream identifier used during encoding.

Example:
sourcevideostring

Source video stream identifier used during encoding.

Example:
fstring

Container format for the output file. Allowed values: mp4, webm, hls, hlsaes. webm requires VP9 or AV1 codec. hls and hlsaes convert to HLS segments and manifest.

Example:
mp4
hlsUnifiedSegmentsboolean

Applicable only when f is hls or hlsaes. When true, audio and video are embedded in the same HLS segments. Enable if compatibility issues occur or when the source has multiple audio tracks (only the first audio track will be encoded).

Example:
false
hlsfMP4Segmentsboolean

Applicable only when f is hls or hlsaes. When true, fMP4 (fragmented MP4) segments are used instead of the default MPEG-TS segments.

Example:
false
cvstring

Video codec. libx264 = H.264, libx265 = H.265, libvpx-vp9 = VP9 (webm only), libaom-av1 = AV1 (advanced feature). Allowed values: libx264, libx265, libvpx-vp9, libaom-av1.

Example:
libx264
svstring

Output resolution preset. Use as_defined to specify a custom resolution via svvalue. 0 means As Source. Allowed values: 2160p, 1440p, 1080p, 720p, 576p, 480p, 360p, 240p, 144p, 0, as_defined.

Example:
720p
svvaluestring

Custom resolution in WIDTHxHEIGHT format. Required when sv is as_defined. Width range 256–7680, height range 144–4320, both values must be divisible by 2.

Example:
1280x720
crfvstring

Constrained Quality factor controlling quality vs file size. 18 = High quality, 24 = Medium quality, 28 = Low quality. Allowed values: 18, 24, 28.

Example:
24
karstring

Keep Aspect Ratio. When set to 1, only height is fixed and width adjusts automatically to preserve the source aspect ratio. Allowed values: 0, 1.

Example:
0
olstring

Orientation Lock. When set to 1, the landscape or portrait orientation of the source video is preserved. Allowed values: 0, 1.

Example:
0
bvstring

Video bitrate mode. 0 = As Source (copy source bitrate), 1 = As Defined (use custom bvvalue). Allowed values: 0, 1.

Example:
1
bvvaluestring

Custom video bitrate in kbps. Required when bv is 1.

Example:
2500
vpassstring

Number of encoding passes. 1 = One Pass, 2 = Two Pass. Disabled when bv is 0. Allowed values: 1, 2.

Example:
1
vprofilestring

Video encoding profile. H.264 (libx264) supports baseline, main, high. H.265 (libx265) supports main, main10. VP9 (libvpx-vp9) supports profile0, profile2. AV1 (libaom-av1) supports main. Allowed values: baseline, main, high, main10, profile0, profile2.

Example:
main
vlevelstring

Encoding level defining resolution and bitrate constraints. Available levels depend on codec and profile selection. Allowed values: 3.0, 3.1, 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2, 6.0, 6.1, 6.2.

Example:
4.0
fpsstring

Frames per second. 0 means As Source. Allowed values: 0, 24, 25, 30, 48, 50, 60.

Example:
30
gopstring

Group of Pictures (keyframe) interval in seconds. Left empty when fps is 0. Allowed values: 2, 4, 6, 8, 10, 12.

Example:
6
presetstring

Encoding speed preset controlling compression efficiency and CPU usage. Faster presets use less CPU but may reduce quality. Allowed values: superfast, veryfast, faster, fast, medium, slow.

Example:
veryfast
tunestring

Encoding tune to optimise for specific content or use case. H.264 supports disabled, film, animation, grain, stillimage, fastdecode. H.265 supports disabled, fastdecode. VP9 and AV1 support disabled only. Allowed values: disabled, film, animation, grain, stillimage, fastdecode.

Example:
disabled
bframestring

Number of consecutive B-frames used in encoding. Higher values improve compression efficiency but increase encoding latency. Allowed values: 0, 1, 2, 3, 4.

Example:
1
upscalestring

Video upscaling. Y = Allow upscaling when source resolution is lower than the target. N = Disallow upscaling. Allowed values: Y, N.

Example:
Y
castring

Audio codec. copy = As Source (pass-through). aac and libmp3lame are for mp4, hls, hlsaes containers. libopus is for webm only. Allowed values: copy, aac, libmp3lame, libopus.

Example:
aac
acastring

Audio channel configuration. 0 = As Source, 1 = Mono, 2 = Stereo. Allowed values: 0, 1, 2.

Example:
2
bastring

Audio bitrate mode. 0 = As Source, 1 = As Defined (use custom bavalue). As Source is not available for webm. Allowed values: 0, 1.

Example:
1
bavaluestring

Audio bitrate in kbps. Required when ba is 1.

Example:
128
arastring

Audio sample rate. 0 = As Source. Allowed values: 0, 44100, 48000.

Example:
44100
tmstring

Thumbnail generation mode. disabled = no thumbnails, fixed = capture once at time tv, interval = capture repeatedly at tv interval, sprite = generate sprite sheet. Allowed values: disabled, fixed, interval, sprite.

Example:
disabled
tvstring

Time value for thumbnail capture in HH:MM:SS format. Required when tm is fixed or interval.

Example:
00:00:05
filtersarray

Array of filter names to apply to the encoding output.

Example:
[]
profilesarray

Array of sub-profile configurations. Applicable when filemode is combined.

Example:
[]

Responses

resultstring

Status of the API response.

messagestring

Human-readable message describing the result.