API docs by Redocly

5centsCDN - Transcoding (1.0.0)

Download OpenAPI specification:Download

API for managing Transcoding in 5centsCDN

Contact Support: Email: help@5centscdn.com

Video Encoding Jobs

endpoints related to manage Video Encoding

List Active Video Encoding Jobs

List all active / pending video encoding job queue for the service

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 4438,
  • "jobid": "228129",
  • "infile": "/raw/A Familiar Visitor.webm",
  • "outfile": "/mp4/raw/A Familiar Visitor_seven.mp4",
  • "percent": "100",
  • "log": "",
  • "error": "",
  • "meta": "{\"zoneid\":\"4438\",\"projectid\":\"4d3c022746b8438b8fe1faab5ded81c4\",\"server\":\"vod-gb-lon-sl01\",\"installation\":\"5\",\"infile\":\"/userdata/home/vineeth_103_push_4438/raw/A Familiar Visitor.webm\",\"command\":\"ffmpeg -hide_banner -err_detect aggressive -stats -loglevel fatal -y -i <infile> -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:a:? -map 0:s:? -c:v:0 libx264 -threads:v:0 2 -preset:v:0 faster -r:v:0 30 -g:v:0 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:0 1280x720 -crf:v:0 24 -minrate:v:0 1340k -maxrate:v:0 2000k -bufsize:v:0 11100k -profile:v:0 high -level:v:0 4.1 -pix_fmt:v:0 yuv420p -c:v:1 libx264 -threads:v:1 2 -preset:v:1 veryfast -r:v:1 30 -g:v:1 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:1 848x480 -crf:v:1 24 -minrate:v:1 1005k -maxrate:v:1 1500k -bufsize:v:1 8325k -profile:v:1 high -level:v:1 4.1 -pix_fmt:v:1 yuv420p -c:v:2 libx264 -threads:v:2 2 -preset:v:2 veryfast -r:v:2 30 -g:v:2 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:2 640x360 -crf:v:2 24 -minrate:v:2 503k -maxrate:v:2 750k -bufsize:v:2 4165k -profile:v:2 main -level:v:2 4.1 -pix_fmt:v:2 yuv420p -c:v:3 libx264 -threads:v:3 2 -preset:v:3 superfast -r:v:3 30 -g:v:3 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:3 424x240 -crf:v:3 24 -minrate:v:3 536k -maxrate:v:3 800k -bufsize:v:3 4440k -profile:v:3 high -level:v:3 4.1 -pix_fmt:v:3 yuv420p -c:v:4 libx264 -threads:v:4 2 -preset:v:4 veryfast -r:v:4 30 -g:v:4 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:4 1920x1080 -crf:v:4 24 -minrate:v:4 2010k -maxrate:v:4 3000k -bufsize:v:4 16650k -profile:v:4 high -level:v:4 4.1 -pix_fmt:v:4 yuv420p -c:v:5 libx264 -threads:v:5 2 -preset:v:5 veryfast -r:v:5 30 -g:v:5 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:5 2560x1440 -crf:v:5 24 -minrate:v:5 2680k -maxrate:v:5 4000k -bufsize:v:5 22200k -profile:v:5 high -level:v:5 4.1 -pix_fmt:v:5 yuv420p -c:v:6 libx264 -threads:v:6 2 -preset:v:6 veryfast -r:v:6 30 -g:v:6 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:6 4096x2160 -crf:v:6 24 -minrate:v:6 3350k -maxrate:v:6 5000k -bufsize:v:6 27750k -profile:v:6 high -level:v:6 4.1 -pix_fmt:v:6 yuv420p -c:a aac -ac:a 2 -b:a:0 128k -ar:a:0 44100 -c:s mov_text -async 1 -vsync 1 -f mp4 -movflags +faststart <outfile>\",\"extension\":\"mp4\",\"outfile\":\"/userdata/home/vineeth_103_push_4438/mp4/raw/A Familiar Visitor_seven.mp4\",\"outdir\":\"/userdata/home/vineeth_103_push_4438/mp4/raw\",\"relativepath\":{\"infile\":\"/raw/A Familiar Visitor.webm\",\"outfile\":\"/mp4/raw/A Familiar Visitor_seven.mp4\"},\"upscale\":{\"allowed\":true},\"out\":{\"videoTracks\":7,\"audioTracks\":1},\"splitted\":{\"command\":\"ffmpeg -hide_banner -err_detect aggressive -stats -loglevel fatal -y -i <infile> -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:a:? -map 0:s:? -c:v:0 libx264 -threads:v:0 2 -preset:v:0 faster -r:v:0 30 -g:v:0 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:0 1280x720 -crf:v:0 24 -minrate:v:0 1340k -maxrate:v:0 2000k -bufsize:v:0 11100k -profile:v:0 high -level:v:0 4.1 -pix_fmt:v:0 yuv420p -c:v:1 libx264 -threads:v:1 2 -preset:v:1 veryfast -r:v:1 30 -g:v:1 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:1 848x480 -crf:v:1 24 -minrate:v:1 1005k -maxrate:v:1 1500k -bufsize:v:1 8325k -profile:v:1 high -level:v:1 4.1 -pix_fmt:v:1 yuv420p -c:v:2 libx264 -threads:v:2 2 -preset:v:2 veryfast -r:v:2 30 -g:v:2 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:2 640x360 -crf:v:2 24 -minrate:v:2 503k -maxrate:v:2 750k -bufsize:v:2 4165k -profile:v:2 main -level:v:2 4.1 -pix_fmt:v:2 yuv420p -c:v:3 libx264 -threads:v:3 2 -preset:v:3 superfast -r:v:3 30 -g:v:3 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:3 424x240 -crf:v:3 24 -minrate:v:3 536k -maxrate:v:3 800k -bufsize:v:3 4440k -profile:v:3 high -level:v:3 4.1 -pix_fmt:v:3 yuv420p -c:v:4 libx264 -threads:v:4 2 -preset:v:4 veryfast -r:v:4 30 -g:v:4 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:4 1920x1080 -crf:v:4 24 -minrate:v:4 2010k -maxrate:v:4 3000k -bufsize:v:4 16650k -profile:v:4 high -level:v:4 4.1 -pix_fmt:v:4 yuv420p -c:v:5 libx264 -threads:v:5 2 -preset:v:5 veryfast -r:v:5 30 -g:v:5 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:5 2560x1440 -crf:v:5 24 -minrate:v:5 2680k -maxrate:v:5 4000k -bufsize:v:5 22200k -profile:v:5 high -level:v:5 4.1 -pix_fmt:v:5 yuv420p -c:v:6 libx264 -threads:v:6 2 -preset:v:6 veryfast -r:v:6 30 -g:v:6 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:6 4096x2160 -crf:v:6 24 -minrate:v:6 3350k -maxrate:v:6 5000k -bufsize:v:6 27750k -profile:v:6 high -level:v:6 4.1 -pix_fmt:v:6 yuv420p -c:a aac -ac:a 2 -b:a:0 128k -ar:a:0 44100 -c:s mov_text -async 1 -vsync 1 -f mp4 -movflags +faststart <outfile>\",\"outdir\":\"/userdata/home/vineeth_103_push_4438/mp4/raw\",\"upload\":\"direct\"}",
  • "created_at": "2025-01-26 03:42:24",
  • "updated_at": "2025-01-26 03:48:49",
  • "timings": {
    },
  • "profile": "seven"
}

List Active Video Encoding Jobs by ZoneID

List all active / pending video encoding job queue for the zone

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4438

(Required) Id of the Push Zone
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
file
string
  • The file path or location of a specific file.
    • Represents the relative or absolute path where the file can be found.
    • Commonly used in applications to reference file resources or media files.
    • Examples of file paths include paths to images, videos, or documents.

Responses

Request samples

Content type
application/json
{
  • "file": "/raw/A Familiar Visitor.webm"
}

Response samples

Content type
application/json
{
  • "id": 4438,
  • "jobid": "228129",
  • "infile": "/raw/A Familiar Visitor.webm",
  • "outfile": "/mp4/raw/A Familiar Visitor_seven.mp4",
  • "percent": "100",
  • "log": "",
  • "error": "",
  • "meta": "{\"zoneid\":\"4438\",\"projectid\":\"4d3c022746b8438b8fe1faab5ded81c4\",\"server\":\"vod-gb-lon-sl01\",\"installation\":\"5\",\"infile\":\"/userdata/home/vineeth_103_push_4438/raw/A Familiar Visitor.webm\",\"command\":\"ffmpeg -hide_banner -err_detect aggressive -stats -loglevel fatal -y -i <infile> -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:a:? -map 0:s:? -c:v:0 libx264 -threads:v:0 2 -preset:v:0 faster -r:v:0 30 -g:v:0 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:0 1280x720 -crf:v:0 24 -minrate:v:0 1340k -maxrate:v:0 2000k -bufsize:v:0 11100k -profile:v:0 high -level:v:0 4.1 -pix_fmt:v:0 yuv420p -c:v:1 libx264 -threads:v:1 2 -preset:v:1 veryfast -r:v:1 30 -g:v:1 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:1 848x480 -crf:v:1 24 -minrate:v:1 1005k -maxrate:v:1 1500k -bufsize:v:1 8325k -profile:v:1 high -level:v:1 4.1 -pix_fmt:v:1 yuv420p -c:v:2 libx264 -threads:v:2 2 -preset:v:2 veryfast -r:v:2 30 -g:v:2 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:2 640x360 -crf:v:2 24 -minrate:v:2 503k -maxrate:v:2 750k -bufsize:v:2 4165k -profile:v:2 main -level:v:2 4.1 -pix_fmt:v:2 yuv420p -c:v:3 libx264 -threads:v:3 2 -preset:v:3 superfast -r:v:3 30 -g:v:3 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:3 424x240 -crf:v:3 24 -minrate:v:3 536k -maxrate:v:3 800k -bufsize:v:3 4440k -profile:v:3 high -level:v:3 4.1 -pix_fmt:v:3 yuv420p -c:v:4 libx264 -threads:v:4 2 -preset:v:4 veryfast -r:v:4 30 -g:v:4 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:4 1920x1080 -crf:v:4 24 -minrate:v:4 2010k -maxrate:v:4 3000k -bufsize:v:4 16650k -profile:v:4 high -level:v:4 4.1 -pix_fmt:v:4 yuv420p -c:v:5 libx264 -threads:v:5 2 -preset:v:5 veryfast -r:v:5 30 -g:v:5 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:5 2560x1440 -crf:v:5 24 -minrate:v:5 2680k -maxrate:v:5 4000k -bufsize:v:5 22200k -profile:v:5 high -level:v:5 4.1 -pix_fmt:v:5 yuv420p -c:v:6 libx264 -threads:v:6 2 -preset:v:6 veryfast -r:v:6 30 -g:v:6 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:6 4096x2160 -crf:v:6 24 -minrate:v:6 3350k -maxrate:v:6 5000k -bufsize:v:6 27750k -profile:v:6 high -level:v:6 4.1 -pix_fmt:v:6 yuv420p -c:a aac -ac:a 2 -b:a:0 128k -ar:a:0 44100 -c:s mov_text -async 1 -vsync 1 -f mp4 -movflags +faststart <outfile>\",\"extension\":\"mp4\",\"outfile\":\"/userdata/home/vineeth_103_push_4438/mp4/raw/A Familiar Visitor_seven.mp4\",\"outdir\":\"/userdata/home/vineeth_103_push_4438/mp4/raw\",\"relativepath\":{\"infile\":\"/raw/A Familiar Visitor.webm\",\"outfile\":\"/mp4/raw/A Familiar Visitor_seven.mp4\"},\"upscale\":{\"allowed\":true},\"out\":{\"videoTracks\":7,\"audioTracks\":1},\"splitted\":{\"command\":\"ffmpeg -hide_banner -err_detect aggressive -stats -loglevel fatal -y -i <infile> -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:V:0? -map 0:a:? -map 0:s:? -c:v:0 libx264 -threads:v:0 2 -preset:v:0 faster -r:v:0 30 -g:v:0 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:0 1280x720 -crf:v:0 24 -minrate:v:0 1340k -maxrate:v:0 2000k -bufsize:v:0 11100k -profile:v:0 high -level:v:0 4.1 -pix_fmt:v:0 yuv420p -c:v:1 libx264 -threads:v:1 2 -preset:v:1 veryfast -r:v:1 30 -g:v:1 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:1 848x480 -crf:v:1 24 -minrate:v:1 1005k -maxrate:v:1 1500k -bufsize:v:1 8325k -profile:v:1 high -level:v:1 4.1 -pix_fmt:v:1 yuv420p -c:v:2 libx264 -threads:v:2 2 -preset:v:2 veryfast -r:v:2 30 -g:v:2 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:2 640x360 -crf:v:2 24 -minrate:v:2 503k -maxrate:v:2 750k -bufsize:v:2 4165k -profile:v:2 main -level:v:2 4.1 -pix_fmt:v:2 yuv420p -c:v:3 libx264 -threads:v:3 2 -preset:v:3 superfast -r:v:3 30 -g:v:3 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:3 424x240 -crf:v:3 24 -minrate:v:3 536k -maxrate:v:3 800k -bufsize:v:3 4440k -profile:v:3 high -level:v:3 4.1 -pix_fmt:v:3 yuv420p -c:v:4 libx264 -threads:v:4 2 -preset:v:4 veryfast -r:v:4 30 -g:v:4 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:4 1920x1080 -crf:v:4 24 -minrate:v:4 2010k -maxrate:v:4 3000k -bufsize:v:4 16650k -profile:v:4 high -level:v:4 4.1 -pix_fmt:v:4 yuv420p -c:v:5 libx264 -threads:v:5 2 -preset:v:5 veryfast -r:v:5 30 -g:v:5 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:5 2560x1440 -crf:v:5 24 -minrate:v:5 2680k -maxrate:v:5 4000k -bufsize:v:5 22200k -profile:v:5 high -level:v:5 4.1 -pix_fmt:v:5 yuv420p -c:v:6 libx264 -threads:v:6 2 -preset:v:6 veryfast -r:v:6 30 -g:v:6 180 -force_key_frames:v \\\"expr:eq(mod(n,180),0)\\\" -x264opts rc-lookahead=180:keyint=360:min-keyint=180 -s:v:6 4096x2160 -crf:v:6 24 -minrate:v:6 3350k -maxrate:v:6 5000k -bufsize:v:6 27750k -profile:v:6 high -level:v:6 4.1 -pix_fmt:v:6 yuv420p -c:a aac -ac:a 2 -b:a:0 128k -ar:a:0 44100 -c:s mov_text -async 1 -vsync 1 -f mp4 -movflags +faststart <outfile>\",\"outdir\":\"/userdata/home/vineeth_103_push_4438/mp4/raw\",\"upload\":\"direct\"}",
  • "created_at": "2025-01-26 03:42:24",
  • "updated_at": "2025-01-26 03:48:49",
  • "timings": {
    },
  • "profile": "seven"
}

Add Video Encoding Jobs

Add a file encoding job

Authorizations:
apikeyAuth
path Parameters
zoneid
required
integer
Example: 4438

(Required) Id of the Push Zone
profileid
required
integer
Example: 1

(Required) Id of the Transcode Profile
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
video
object
  • Represents a mapping of video-related details or properties.
    • This could include metadata such as resolution, format, or codec.
    • Example values could be mappings like { "resolution": "1920x1080", "codec": "H.264" } or { "format": "mp4", "bitrate": "4 Mbps" }.
audio
object
  • Represents a mapping of audio-related details or properties.
    • This could include metadata such as format, bitrate, or channels.
    • Example values could be mappings like { "format": "AAC", "bitrate": "128 kbps" } or { "channels": 2, "sample_rate": "44100 Hz" }.
subtitle
object
  • Represents a mapping of subtitle-related details or properties.
    • This could include metadata such as language, format, or encoding.
    • Example values could be mappings like { "language": "English", "format": "SRT" } or { "encoding": "UTF-8", "language": "Spanish" }.
file
string
  • The file path or location of a specific file.
    • Represents the relative or absolute path where the file can be found.
    • Commonly used in applications to reference file resources or media files.
    • Examples of file paths include paths to images, videos, or documents.
priority
integer
  • Represents the priority level assigned to the task or file.
    • A higher number indicates higher priority.
    • Example values could be 66 (medium priority) or 100 (high priority).

Responses

Request samples

Content type
application/json
{
  • "video": {
    },
  • "audio": {
    },
  • "subtitle": {
    },
  • "file": "/raw/A Familiar Visitor.webm",
  • "priority": 66
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "jobid": 229453
}

Retry enoding job

Retry an encoding job, after fixing issues

Authorizations:
apikeyAuth
path Parameters
jobid
required
integer
Example: 229453

(Required) Id of the VideEncoding job
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[ ]

Cancel Enoding Job

Cancel an encoding job. Jobs can be cancelled only before its get processed.

Authorizations:
apikeyAuth
path Parameters
jobid
required
integer
Example: 222589

(Required) Id of the VideEncoding job
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[ ]

Video Encoding Minutes Reports

Reports for Video Transcoding Minutes

Reports by Video Encoding Minutes

Get reports of Video Encoding Minutes

Authorizations:
apikeyAuth
header Parameters
r
string
Example: <string>

(Required) Enter date range format should be yyyy-mm-dd hh:min:sec - yyyy-mm-dd hh:min:sec
For example 2020-10-15 10:41:00 - 2020-10-22 10:41:00
f
string
Example: <string>

Enter reported by
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "zones": [
    ],
  • "logs": [
    ],
  • "logsinfo": {
    }
}

Video Encoding Profiles

Create Global Auto Transcode Preset Profiles

These presets will be automatically added to your new zones

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "defaultprofiles": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

Create Transcoding Profiles

Create Transcoding Profiles

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name of the transcoding profile.
    • Represents the unique identifier for the profile.
    • Example values: 'kippo', 'default-profile'.
outdir
string
  • The output directory where transcoded files will be stored.
    • Specifies the relative or absolute path.
    • Example values: 'mp4/', '/videos/output/'.
f
string
  • The format of the output file.
    • Determines the container format for the transcoded file.
    • Example values: 'mp4', 'mkv', 'avi'.
cv
string
  • The codec used for video compression.
    • Specifies the codec to encode the video stream.
    • Example values: 'libx264', 'libx265', 'vp9'.
sv
integer
  • Flag indicating whether a specific value is set for the stream.
    • Determines whether a stream value is enabled (1) or disabled (0).
    • Example values: 0, 1.
svvalue
string
  • The specific value associated with the stream, if applicable.
    • This is left empty if no value is set.
    • Example values: '', 'specific-stream-value'.
crfv
integer
  • Constant Rate Factor for video compression.
    • Determines the quality of the video with smaller values being higher quality.
    • Example values: 18, 24, 28.
bv
integer
  • Flag indicating whether a specific bitrate is set for the video stream.
    • Determines whether the bitrate is applied (1) or not (0).
    • Example values: 0, 1.
bvvalue
integer
  • The bitrate value for the video stream in kbps.
    • Specifies the target bitrate for the video encoding.
    • Example values: 1000, 2000, 4000.
vpass
integer
  • Number of passes used for video encoding.
    • Determines whether the encoding uses single-pass (1) or two-pass (2) encoding.
    • Example values: 1, 2.
vprofile
string
  • The video encoding profile used for compression.
    • Specifies the compression profile, such as baseline or high profile.
    • Example values: 'disabled', 'baseline', 'high'.
fps
integer
  • Frames per second for the video output.
    • Controls the frame rate of the transcoded video.
    • Example values: 24, 30, 60.
gop
integer
  • Group of Pictures size for the video encoding.
    • Specifies the interval between keyframes.
    • Example values: 10, 30, 60.
upscale
string
  • Flag indicating whether to upscale the video resolution.
    • Determines if video resolution is increased during transcoding.
    • Example values: 'Y', 'N'.
ca
string
  • The codec used for audio compression.
    • Specifies the codec to encode the audio stream.
    • Example values: 'aac', 'mp3', 'opus'.
aca
integer
  • Number of audio channels in the output file.
    • Determines the audio channel configuration (e.g., stereo, mono).
    • Example values: 1, 2, 6.
ba
integer
  • Flag indicating whether a specific bitrate is set for the audio stream.
    • Determines whether the bitrate is applied (1) or not (0).
    • Example values: 0, 1.
bavalue
integer
  • The bitrate value for the audio stream in kbps.
    • Specifies the target bitrate for the audio encoding.
    • Example values: 64, 80, 128.
ara
integer
  • The audio sampling rate in Hz.
    • Determines the audio quality and frequency range.
    • Example values: 44100, 48000.
tm
string
  • The transcoding mode.
    • Specifies whether transcoding is time-limited or disabled.
    • Example values: 'disabled', 'enabled'.
tv
string
  • The maximum duration for the transcoded video.
    • Specifies the time limit for the output file.
    • Example values: '01:00:00', '06:00:00'.
filters
Array of integers
  • List of filters applied to the transcoded file.
    • Specifies the filter identifiers used during processing.
    • Example values: [1, 2, 5].
_METHOD
string
  • The HTTP method used for the transcoding request.
    • Specifies the action to be performed (e.g., PUT, POST).
    • Example values: 'PUT', 'POST'.
filemode
string
  • The file mode for processing.
    • Indicates whether a single file or multiple files are processed.
    • Example values: 'Single', 'Batch'.

Responses

Request samples

Content type
application/json
{
  • "name": "kippo",
  • "outdir": "mp4/",
  • "f": "mp4",
  • "cv": "libx264",
  • "sv": 0,
  • "svvalue": "",
  • "crfv": 24,
  • "bv": 1,
  • "bvvalue": 2000,
  • "vpass": 1,
  • "vprofile": "disabled",
  • "fps": 30,
  • "gop": 10,
  • "upscale": "Y",
  • "ca": "aac",
  • "aca": 2,
  • "ba": 1,
  • "bavalue": 80,
  • "ara": 44100,
  • "tm": "disabled",
  • "tv": "06:00:00",
  • "filters": [
    ],
  • "_METHOD": "PUT",
  • "filemode": "Single"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings, New Profile Created",
  • "profileid": 110860
}

Edit Transcoding Profile

Edit Transcoding Profile

Authorizations:
apikeyAuth
path Parameters
profileid
required
integer
Example: 110860

(Required) Id of the Transcode Profile
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name of the transcoding profile.
    • Represents the identifier for the profile.
    • Examples: 'kippo', 'fast_transcode', 'high_quality'.
outdir
string
  • The output directory where the transcoded files will be saved.
    • Defines the path relative to the application's working directory.
    • Examples: 'mp4/', 'output_files/', 'transcodes/'.
f
string
  • The output format of the transcoded file.
    • Specifies the container format.
    • Examples: 'mp4', 'mkv', 'avi'.
cv
string
  • The codec to be used for video encoding.
    • Specifies the video codec for the transcoding process.
    • Examples: 'libx264', 'libx265', 'vp9'.
sv
number
  • An indicator for whether to include subtitles in the output.
    • A value of 0 disables subtitles, while 1 enables them.
    • Examples: 0 (no subtitles), 1 (include subtitles).
svvalue
string
  • The subtitle file or stream to use if subtitles are enabled.
    • Typically, a file path or stream identifier.
    • Examples: 'subtitles.srt', ''.
crfv
number
  • The Constant Rate Factor value for controlling video quality.
    • Lower values result in better quality but larger file sizes.
    • Examples: 18, 24, 30.
bv
number
  • A flag indicating whether to set a custom video bitrate.
    • A value of 0 uses default settings, while 1 enables customization.
    • Examples: 0 (default bitrate), 1 (custom bitrate).
bvvalue
number
  • The custom video bitrate in kilobits per second (kbps).
    • Specifies the target bitrate for the video.
    • Examples: 1000, 2000, 5000.
vpass
number
  • The number of passes for video encoding.
    • A value of 1 indicates single-pass encoding, while 2 indicates two-pass encoding for better quality.
    • Examples: 1, 2.
vprofile
string
  • The video profile setting for the codec.
    • Determines encoding complexity and compatibility.
    • Examples: 'baseline', 'main', 'high', 'disabled'.
fps
number
  • Frames per second for the transcoded video.
    • Specifies the frame rate for the output.
    • Examples: 24, 30, 60.
gop
number
  • The Group of Pictures (GOP) size.
    • Defines the interval between keyframes in the video.
    • Examples: 10, 30, 60.
preset
string
  • The encoding preset for the transcoder.
    • Affects the speed and efficiency of encoding.
    • Examples: 'ultrafast', 'superfast', 'medium'.
upscale
string
  • Indicates whether to upscale the video resolution.
    • 'Y' enables upscaling, 'N' disables it.
    • Examples: 'Y', 'N'.
ca
string
  • The codec to be used for audio encoding.
    • Specifies the audio codec for the transcoding process.
    • Examples: 'aac', 'mp3', 'opus'.
aca
number
  • The number of audio channels in the output.
    • Defines the audio configuration (e.g., stereo or mono).
    • Examples: 1, 2, 6.
ba
number
  • A flag indicating whether to set a custom audio bitrate.
    • A value of 0 uses default settings, while 1 enables customization.
    • Examples: 0 (default bitrate), 1 (custom bitrate).
bavalue
number
  • The custom audio bitrate in kilobits per second (kbps).
    • Specifies the target bitrate for the audio.
    • Examples: 64, 80, 128.
ara
number
  • The audio sample rate in Hertz (Hz).
    • Defines the sampling frequency for the audio.
    • Examples: 44100, 48000, 96000.
tm
string
  • The transcoding mode.
    • Specifies whether transcoding is enabled or disabled.
    • Examples: 'enabled', 'disabled'.
tv
string
  • The target duration for the output video.
    • Specifies the desired video length.
    • Examples: '06:00:00', '00:30:00'.
filters
Array of numbers
  • A list of filter IDs to be applied during transcoding.
    • Specifies enhancements or modifications to the video.
    • Examples: [1, 2, 5].
filemode
string
  • The mode for processing files.
    • Specifies whether files are processed individually or in batches.
    • Examples: 'Single', 'Batch'.

Responses

Request samples

Content type
application/json
{
  • "name": "kippo",
  • "outdir": "mp4/",
  • "f": "mp4",
  • "cv": "libx264",
  • "sv": 0,
  • "svvalue": "",
  • "crfv": 24,
  • "bv": 1,
  • "bvvalue": 2000,
  • "vpass": 1,
  • "vprofile": "disabled",
  • "fps": 30,
  • "gop": 10,
  • "preset": "superfast",
  • "upscale": "Y",
  • "ca": "aac",
  • "aca": 2,
  • "ba": 1,
  • "bavalue": 80,
  • "ara": 44100,
  • "tm": "disabled",
  • "tv": "06:00:00",
  • "filters": [
    ],
  • "filemode": "Single"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

Delete Transcoding Profile

Delete the information of Transcoding Profile. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
profileid
required
integer
Example: 110860

(Required) Id of the Transcode Profile
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

List File Transcoding Profiles

List File Transcoding Profiles

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "profiles": {
    }
}

Create File Transcoding Filters

Create File Transcoding Filters

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name of the transcoding filter.
    • Used to identify the filter within the application or system.
    • Example values: 'flutter', 'watermark'.
filter
string
  • Specifies the type of filter to be applied during transcoding.
    • Commonly used to define actions like overlaying text or adding effects.
    • Example values: 'drawtext', 'overlay'.
object
object
url
string
  • The URL for the overlay resource. - Specifies the location of an image or other media to be used in the overlay. - Example values: 'https://example.com/logo.png', ''.
scale
string
  • Defines the scale of the overlay relative to the video dimensions. - Determines how large or small the overlay appears. - Example values: '50%', '1920x1080'.
position
string
  • Specifies the position of the overlay on the video. - Determines where the overlay will be placed. - Example values: 'top-right', 'center'.
object
text
string
  • The text to be displayed on the video. - Represents the actual content of the text overlay. - Example values: 'Flutter', 'Hello, World!'.
fontsize
integer
  • The size of the font for the text overlay. - Determines how large the text appears on the video. - Example values: 16, 24.
fontcolor
string
  • The color of the font for the text overlay. - Represented as a hexadecimal color code. - Example values: '#2599f8', '#FF5733'.
position
string
  • The position of the text overlay on the video. - Determines where the text will appear on the screen. - Example values: 'Top Left', 'Bottom Right'.
_METHOD
string
  • Specifies the HTTP method to be used for the request.
    • Indicates the action being performed, such as creating or updating a filter.
    • Example values: 'PUT', 'POST'.

Responses

Request samples

Content type
application/json
{
  • "name": "flutter",
  • "filter": "drawtext",
  • "args": {
    },
  • "_METHOD": "PUT"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings, New Filter Created",
  • "filterid": 324
}

Edit Transcoding Profile Filter

Edit Transcoding Profile Filter

Authorizations:
apikeyAuth
path Parameters
filterid
required
integer
Example: 324

(Required) Id of the Transcode Profile filter

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name associated with the configuration or filter.
    • Used to identify the specific settings being applied.
    • Example values: 'flutter', 'example-filter'.
object
text
string
  • The text to be displayed as part of the filter. - Represents the main content for the text overlay. - Example values: 'Flutter', 'Welcome'.
fontsize
integer
  • The size of the font for the displayed text. - Determines how large the text appears. - Example values: 16, 24.
fontcolor
string
  • The color of the font for the displayed text. - Represented as a hexadecimal color code. - Example values: '#2599f8', '#FF0000'.
position
string
  • The position of the text on the screen. - Specifies where the text will appear in the layout. - Example values: 'Top Left', 'Bottom Right'.

Responses

Request samples

Content type
application/json
{
  • "name": "flutter",
  • "args": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

Edit Transcoding Profile Filter

Delete the information of Transcoding Profile filter. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
filterid
required
integer
Example: 324

(Required) Id of the Transcode Profile filter

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

List File Transcoding Filters

List File Transcoding Filters

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "filters": {
    }
}