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

Bitmovin JS/TS API SDK

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