Add Thumbnail

post https://api.bitmovin.com/v1/encoding/encodings/{encoding_id}/streams/{stream_id}/thumbnails

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

encoding_id

string

required

Id of the encoding.

stream_id

string

required

Id of the stream.

Body Params

The Thumbnail to be added

name

string

Name of the resource. Can be freely chosen by the user.

description

string

Description of the resource. Can be freely chosen by the user.

customData

string

User-specific meta data. This can hold anything.

height

integer

Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.

width

integer

Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported

pattern

string

required

Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s).

interval

double

The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.

positions

array of doubles

Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.

positions

outputs

array of objects

required

outputs*

unit

string

Defaults to SECONDS

Unit of the values in the positions array.

aspectMode

string

Defaults to STRETCH

Specifies the aspect mode that is used when both height and width are specified
Only supported starting with encoder version 2.85.0.

Responses

Language

Credentials


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.bitmovin.com/v1/encoding/encodings//streams//thumbnails \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "unit": "SECONDS",
8
  "aspectMode": "STRETCH"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response.

defaultError response.