@bitmovin/api-sdk/dist/encoding/encodings/sidecars/webvtt/WebvttApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import WebVttSidecarFile from '../../../../models/WebVttSidecarFile';
import PaginationResponse from '../../../../models/PaginationResponse';
import { WebVttSidecarFileListQueryParams, WebVttSidecarFileListQueryParamsBuilder } from './WebVttSidecarFileListQueryParams';
/**
 * WebvttApi - object-oriented interface
 * @export
 * @class WebvttApi
 * @extends {BaseAPI}
 */
export default class WebvttApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Add WebVTT sidecar file
     * @param {string} encodingId Id of the encoding.
     * @param {WebVttSidecarFile} webVttSidecarFile The WebVTT Sidecar file to be added
     * @throws {BitmovinError}
     * @memberof WebvttApi
     */
    create(encodingId: string, webVttSidecarFile?: WebVttSidecarFile): Promise<WebVttSidecarFile>;
    /**
     * @summary Delete Sidecar
     * @param {string} encodingId Id of the encoding.
     * @param {string} sidecarId Id of the sidecar.
     * @throws {BitmovinError}
     * @memberof WebvttApi
     */
    delete(encodingId: string, sidecarId: string): Promise<BitmovinResponse>;
    /**
     * @summary WebVTT Sidecar Details
     * @param {string} encodingId Id of the encoding.
     * @param {string} sidecarId Id of the sidecar.
     * @throws {BitmovinError}
     * @memberof WebvttApi
     */
    get(encodingId: string, sidecarId: string): Promise<WebVttSidecarFile>;
    /**
     * @summary List WebVTT sidecar files
     * @param {string} encodingId Id of the encoding.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof WebvttApi
     */
    list(encodingId: string, queryParameters?: WebVttSidecarFileListQueryParams | ((q: WebVttSidecarFileListQueryParamsBuilder) => WebVttSidecarFileListQueryParamsBuilder)): Promise<PaginationResponse<WebVttSidecarFile>>;
}