Class Thumbnail

Export

Thumbnail

Hierarchy (view full)

Constructors

constructor

Properties

aspectMode? createdAt? customData? description? height? id? interval? modifiedAt? name? outputs? pattern? positions? unit? width?

Constructors

constructor

Properties

Optional aspectMode

aspectMode?: ThumbnailAspectMode

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

Memberof

Thumbnail

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

Optional description

description?: string

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

Memberof

BitmovinResource

Optional height

height?: number

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.

Memberof

Thumbnail

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

Optional interval

interval?: number

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.

Memberof

Thumbnail

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

Optional name

name?: string

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

Memberof

BitmovinResource

Optional outputs

outputs?: EncodingOutput[]

Memberof

Thumbnail

Optional pattern

pattern?: string

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). (required)

Memberof

Thumbnail

Optional positions

positions?: number[]

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

Memberof

Thumbnail

Optional unit

unit?: ThumbnailUnit

Unit of the values in the positions array.

Memberof

Thumbnail

Optional width

width?: number

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

Memberof

Thumbnail

Settings

Member Visibility

Theme

On This Page

constructoraspectModecreatedAtcustomDatadescriptionheightidintervalmodifiedAtnameoutputspatternpositionsunitwidth