@bitmovin/api-sdk/dist/encoding/encodings/captions/scc/SccApi.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 ConvertSccCaption from '../../../../models/ConvertSccCaption';
import PaginationResponse from '../../../../models/PaginationResponse';
import { ConvertSccCaptionListQueryParams, ConvertSccCaptionListQueryParamsBuilder } from './ConvertSccCaptionListQueryParams';
/**
 * SccApi - object-oriented interface
 * @export
 * @class SccApi
 * @extends {BaseAPI}
 */
export default class SccApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Convert SCC captions
     * @param {string} encodingId Id of the encoding.
     * @param {ConvertSccCaption} convertSccCaption The SCC captions to be created
     * @throws {BitmovinError}
     * @memberof SccApi
     */
    create(encodingId: string, convertSccCaption?: ConvertSccCaption): Promise<ConvertSccCaption>;
    /**
     * @summary Delete Convert SCC captions
     * @param {string} encodingId Id of the encoding.
     * @param {string} captionsId Id of the caption.
     * @throws {BitmovinError}
     * @memberof SccApi
     */
    delete(encodingId: string, captionsId: string): Promise<BitmovinResponse>;
    /**
     * @summary Convert SCC captions Details
     * @param {string} encodingId Id of the encoding.
     * @param {string} captionsId Id of the caption.
     * @throws {BitmovinError}
     * @memberof SccApi
     */
    get(encodingId: string, captionsId: string): Promise<ConvertSccCaption>;
    /**
     * @summary List Convert SCC captions
     * @param {string} encodingId Id of the encoding.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof SccApi
     */
    list(encodingId: string, queryParameters?: ConvertSccCaptionListQueryParams | ((q: ConvertSccCaptionListQueryParamsBuilder) => ConvertSccCaptionListQueryParamsBuilder)): Promise<PaginationResponse<ConvertSccCaption>>;
}