Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languageyml
themeRDark
profiles:
 
 -webrtc-144:
  audio:
    codec : opus
    rate : 48000
    channels : 2
  video:
    width : 256
    height : 144
    codecImpl : OPENH264

...

ParameterValues availableDescription
Audio parameters
codec

opus

mpeg4-generic

speex

ulaw

Audio codec to use
bitrateDepends on quality required and bandwidth availableAudio bitrate, bps
rate

8000

11025

12000

16000

22050

24000

32000

44100

48000

Audio sample rate, kHzchannels

1

2

Channels quantity: mono or stereo
Video parameters
codec

h264

mpv

vp8

Video codec to use
bitrateDepends on quality required and bandwidth availableVideo bitrate, kbps
widthDepends on quality required and bandwidth availablePicture width
heightDepends on quality required and bandwidth availablePicture height
codeImpl

FF

OPENH264

Video codec used, FF by default
gopDepends on quality required and bandwidth availableKey frames frequency (GOP)
fpsDepends on quality required and bandwidth availableFrames frequency per second
qualityDepends on quality required and bandwidth availableVideo quality
preset

ultrafast

superfast

veryfast

faster

fast

medium

slow

slower

veryslow

placebo

FF preset, ultrafast by default
profileDepends on required quality
FF profile, Baseline by default
levelDepends on required quality
FF level, 3.1 by default

...

REST query

REST query body example

Response body example

Response states

Description

/cdn/profile/add

Code Block
languagejs
themeRDark
{
"name": "-profile1",
"profile": {
        "audio": {
            "type": "audio",
            "bitrate": 0, 
            "channels": 0, 
            "codec": "opus", 
            "rate": 48000 
        }, 
        "video": {
            "type": "video", 
            "bitrate": 0, 
            "codec": "h264", 
            "codecImpl": "FF", 
            "fps": 30, 
            "gop": 90, 
            "height": 360, 
            "quality": 0, 
            "width": 640
        }
}
}





200 – OK

400 - Bad Request

409 - Conflict

500 – Internal Server Error

Add transcoding profile

/cdn/profile/modify
Code Block
languagejs
themeRDark
{
"name": "-profile1",
"profile": {
        "video": {
            "bitrate": 400, 
            "quality": 25
        }
}
}




200 – OK

400 - Bad Request

404 - Not Found

500 – Internal Server Error

Change transcoding profile
/cdn/profile/print
Code Block
languagejs
themeRDark
    "-240p": {
        "audio": {
            "bitrate": 0, 
            "channels": 0, 
            "codec": "opus", 
            "rate": 48000, 
            "type": "audio"
        }, 
        "video": {
            "bitrate": 0, 
            "codec": "h264", 
            "codecImpl": "FF", 
            "fps": 25, 
            "gop": 50, 
            "height": 240, 
            "preset": "veryfast", 
            "quality": 0, 
            "type": "video", 
            "width": 0
        }
    }, 
    "-480p": {
        "audio": {
            "bitrate": 0, 
            "channels": 0, 
            "codec": "opus", 
            "rate": 48000, 
            "type": "audio"
        }, 
        "video": {
            "bitrate": 0, 
            "codec": "h264", 
            "codecImpl": "FF", 
            "fps": 25, 
            "gop": 50, 
            "height": 480, 
            "preset": "veryfast", 
            "quality": 0, 
            "type": "video", 
            "width": 0
        }
    }

200 – OK

404 - Not Found

500 – Internal Server Error

Get the transcoding profiles list
/cdn/profile/remove
Code Block
languagejs
themeRDark
{
"name": "-profile1"
}




200 – OK

404 - Not Found

500 – Internal Server Error

Remove transcoding profile

...

The mandatory profile parameters are:

  • audio:
    • bitrate
    • codec
    • ratechannels
  • video:
    • bitrate
    • codec
    • width
    • height
    • quality

...