@bitmovin/api-sdk/dist/models/Thumbnail.d.ts

Bitmovin JS/TS API SDK

import BitmovinResource from './BitmovinResource';
import EncodingOutput from './EncodingOutput';
import ThumbnailAspectMode from './ThumbnailAspectMode';
import ThumbnailUnit from './ThumbnailUnit';
/**
 * @export
 * @class Thumbnail
 */
export declare class Thumbnail extends BitmovinResource {
    /**
     * 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.
     * @type {number}
     * @memberof Thumbnail
     */
    height?: 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
     * @type {number}
     * @memberof Thumbnail
     */
    width?: number;
    /**
     *  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)
     * @type {string}
     * @memberof Thumbnail
     */
    pattern?: string;
    /**
     * 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.
     * @type {number}
     * @memberof Thumbnail
     */
    interval?: number;
    /**
     * Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.
     * @type {number[]}
     * @memberof Thumbnail
     */
    positions?: number[];
    /**
     * @type {EncodingOutput[]}
     * @memberof Thumbnail
     */
    outputs?: EncodingOutput[];
    /**
     * Unit of the values in the positions array.
     * @type {ThumbnailUnit}
     * @memberof Thumbnail
     */
    unit?: ThumbnailUnit;
    /**
     * Specifies the aspect mode that is used when both height and width are specified Only supported starting with encoder version `2.85.0`.
     * @type {ThumbnailAspectMode}
     * @memberof Thumbnail
     */
    aspectMode?: ThumbnailAspectMode;
    constructor(obj?: Partial<Thumbnail>);
}
export default Thumbnail;