@bitmovin/api-sdk/dist/encoding/encodings/streams/thumbnails/ThumbnailsApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import Thumbnail from '../../../../models/Thumbnail';
import PaginationResponse from '../../../../models/PaginationResponse';
import { ThumbnailListQueryParams, ThumbnailListQueryParamsBuilder } from './ThumbnailListQueryParams';
/**
 * ThumbnailsApi - object-oriented interface
 * @export
 * @class ThumbnailsApi
 * @extends {BaseAPI}
 */
export default class ThumbnailsApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Add Thumbnail
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {Thumbnail} thumbnail The Thumbnail to be added
     * @throws {BitmovinError}
     * @memberof ThumbnailsApi
     */
    create(encodingId: string, streamId: string, thumbnail?: Thumbnail): Promise<Thumbnail>;
    /**
     * @summary Delete Thumbnail
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {string} thumbnailId Id of the thumbnail.
     * @throws {BitmovinError}
     * @memberof ThumbnailsApi
     */
    delete(encodingId: string, streamId: string, thumbnailId: string): Promise<BitmovinResponse>;
    /**
     * @summary Thumbnail Details
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {string} thumbnailId Id of the thumbnail.
     * @throws {BitmovinError}
     * @memberof ThumbnailsApi
     */
    get(encodingId: string, streamId: string, thumbnailId: string): Promise<Thumbnail>;
    /**
     * @summary List Thumbnails
     * @param {string} encodingId Id of the encoding.
     * @param {string} streamId Id of the stream.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof ThumbnailsApi
     */
    list(encodingId: string, streamId: string, queryParameters?: ThumbnailListQueryParams | ((q: ThumbnailListQueryParamsBuilder) => ThumbnailListQueryParamsBuilder)): Promise<PaginationResponse<Thumbnail>>;
}