Update a encoding profile

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

projId

string

required

Example:

f32a0116-fe11-454c-8e6a-5ff4101882e5

encodingType

string

required

Example:

vod

profileId

string

required

Example:

2c337aa2-5a5d-41c7-99c7-2a1218c3c46f

Body Params application/json

id

string

required

Unique identifier for the object.

project_id

string

required

Identifier of the project to which this object belongs.

name

string

required

Name of the object.

is_default

boolean

required

Indicates whether this object is the default one.

enable_per_title_encoding

boolean

required

Specifies whether per-title encoding is enabled for this object.

thumbnail

object

required

time

number

required

Time in seconds where the thumbnail was captured.

image_format

string

required

Format of the thumbnail image.

height

integer

required

Height of the thumbnail image in pixels.

width

integer

required

Width of the thumbnail image in pixels.

output_path

string

required

Path where the thumbnail image is stored.

generate_mp4

boolean

required

Specifies whether to generate an MP4 version of the object.

crop

object

required

x

integer

required

X-coordinate of the top-left corner of the cropping area.

y

integer

required

Y-coordinate of the top-left corner of the cropping area.

out_w

integer

required

Width of the cropped area in pixels.

out_h

integer

required

Height of the cropped area in pixels.

image_overlay

object

required

url

string

required

URL of the image overlay.

text_overlay

object

required

text

string

required

Text content of the overlay.

trim

object

required

start

integer

required

Start time of the trimmed portion in seconds.

end

integer

required

End time of the trimmed portion in seconds.

encoding_presets

array [object {9}]

required

width

integer

required

Width of the encoded video.

height

integer

required

Height of the encoded video.

min_bitrate

integer

required

Minimum bitrate for encoding.

max_bitrate

integer

required

Maximum bitrate for encoding.

optimize_bitrate

boolean

required

Specifies whether to optimize the bitrate.

bitrate

integer

required

Bitrate for encoding.

video_codec

string

required

Video codec used for encoding.

audio_codec

string

required

Audio codec used for encoding.

audio_rate

integer

required

Audio sampling rate for encoding.

Example

{
    "id": "2c337aa2-5a5d-41c7-99c7-2a1218c3c46f",
    "project_id" : "f32a0116-fe11-454c-8e6a-5ff4101882e5",
    "name": "Profile3 new",
    "is_default": true,
    "enable_per_title_encoding": false,
    "thumbnail": {
        "time" : 0.1 ,
        "image_format" : "jpg" ,
        "height" :270,
        "width" : 270,
        "output_path" : ".jpg"
    },
    "generate_mp4": true,
    "crop": {
        "x": 10,
        "y": 20,
        "out_w": 100,
        "out_h": 200
    },
    "image_overlay": {
        "url": "http://example.com/overlay.jpg"
    },
    "text_overlay": {
        "text": "Raka"
    },
    "trim": {
        "start": 10,
        "end": 20
    },
   "encoding_presets": [
        {
            "width": 2048,
            "height": 1920,
            "min_bitrate": 2000,
            "max_bitrate": 4000,
            "optimize_bitrate": true,
            "bitrate": 0,
            "video_codec": "h264",
            "audio_codec": "aac",
            "audio_rate": 128
        },
        {
            "width": 1080,
            "height": 7200,
            "min_bitrate": 2000,
            "max_bitrate": 6000,
            "optimize_bitrate": true,
            "bitrate": 0,
            "video_codec": "h265",
            "audio_codec": "aac",
            "audio_rate": 128
        }
   ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'http://localhost:8080/v1/projects/f32a0116-fe11-454c-8e6a-5ff4101882e5/encoding-profiles/vod/2c337aa2-5a5d-41c7-99c7-2a1218c3c46f' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "2c337aa2-5a5d-41c7-99c7-2a1218c3c46f",
    "project_id" : "f32a0116-fe11-454c-8e6a-5ff4101882e5",
    "name": "Profile3 new",
    "is_default": true,
    "enable_per_title_encoding": false,
    "thumbnail": {
        "time" : 0.1 ,
        "image_format" : "jpg" ,
        "height" :270,
        "width" : 270,
        "output_path" : ".jpg"
    },
    "generate_mp4": true,
    "crop": {
        "x": 10,
        "y": 20,
        "out_w": 100,
        "out_h": 200
    },
    "image_overlay": {
        "url": "http://example.com/overlay.jpg"
    },
    "text_overlay": {
        "text": "Raka"
    },
    "trim": {
        "start": 10,
        "end": 20
    },
   "encoding_presets": [
        {
            "width": 2048,
            "height": 1920,
            "min_bitrate": 2000,
            "max_bitrate": 4000,
            "optimize_bitrate": true,
            "bitrate": 0,
            "video_codec": "h264",
            "audio_codec": "aac",
            "audio_rate": 128
        },
        {
            "width": 1080,
            "height": 7200,
            "min_bitrate": 2000,
            "max_bitrate": 6000,
            "optimize_bitrate": true,
            "bitrate": 0,
            "video_codec": "h265",
            "audio_codec": "aac",
            "audio_rate": 128
        }
   ]
}'

Responses

🟢200OK final 1

application/json

Body

message

string

required

A string that contains a message about the success or failure of the API request.

result

object

required

An object that represents an encoding profile.

thumbnail

object

required

An object containing information about the thumbnail image, including the height, width, image format, output path, and timestamp.

crop

object

required

An object containing information about the crop settings, including the output height and width, and the x and y coordinates of the crop region.

image_overlay

object

required

An object containing information about an image overlay, including the URL of the image to be overlaid.

text_overlay

object

required

An object containing information about a text overlay, including the text to be displayed.

trim

object

required

An object containing information about the trim settings, including the start and end times.

created_at

string

required

The date and time the profile was created.

encoding_presets

array [object {11}]

required

An array of encoding presets associated with the profile.

name

string

required

The name of the encoding profile.

id

string

required

A unique identifier for the encoding profile.

project_id

string

required

A unique identifier for the project associated with the encoding profile.

created_by

string

required

The ID of the user who created the encoding profile.

is_default

boolean

required

Indicates whether this profile is the default profile for the project.

enable_per_title_encoding

boolean

required

Indicates whether per-title encoding is enabled for this encoding profile.

generate_mp4

boolean

required

Indicates whether an MP4 file should be generated for the encoding profile.

success

boolean

required

A boolean indicating whether the API request was successful.

Example

{"message":"Encoding Updated Successfully","result":{"thumbnail":{"height":270,"image_format":"jpg","output_path":".jpg","time":0.1,"width":270},"crop":{"out_h":200,"out_w":100,"x":10,"y":20},"image_overlay":{"url":"http://example.com/overlay.jpg"},"text_overlay":{"text":"Raka"},"trim":{"end":20,"start":10},"created_at":"2024-04-17T16:47:34+06:00","encoding_presets":[{"video_codec":"h264","audio_codec":"aac","width":2048,"height":1920,"min_bitrate":2000,"max_bitrate":4000,"bitrate":0,"audio_rate":128,"id":"1ca339db-d3a3-44ce-be97-7f377ef09a47","encoding_profile_id":"47f8da4f-a35b-463f-9343-10d29980d8b9","optimize_bitrate":true},{"video_codec":"h265","audio_codec":"aac","width":1080,"height":7200,"min_bitrate":2000,"max_bitrate":6000,"bitrate":0,"audio_rate":128,"id":"c4d6f99d-6bb3-4883-bd7d-76f8eeafd94d","encoding_profile_id":"47f8da4f-a35b-463f-9343-10d29980d8b9","optimize_bitrate":true}],"name":"Profile3 new","id":"47f8da4f-a35b-463f-9343-10d29980d8b9","project_id":"8813d154-3e6a-457e-bcdb-283ede3fe365","created_by":"04f131d0-b8d5-42cd-8e66-9495299e75cf","is_default":true,"enable_per_title_encoding":false,"generate_mp4":true},"success":true}

Update a encoding profile