@bitmovin/api-sdk/dist/encoding/encodings/muxings/progressiveTs/id3/plainText/PlainTextApi.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 PlaintextId3Tag from '../../../../../../models/PlaintextId3Tag';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { PlaintextId3TagListQueryParams, PlaintextId3TagListQueryParamsBuilder } from './PlaintextId3TagListQueryParams';
/**
 * PlainTextApi - object-oriented interface
 * @export
 * @class PlainTextApi
 * @extends {BaseAPI}
 */
export default class PlainTextApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Add Plain Text ID3 Tag to a Progressive TS muxing
     * @param {string} encodingId ID of the Encoding.
     * @param {string} muxingId ID of the Progressive TS muxing
     * @param {PlaintextId3Tag} plaintextId3Tag The Plain Text ID3 Tag to be created
     * @throws {BitmovinError}
     * @memberof PlainTextApi
     */
    create(encodingId: string, muxingId: string, plaintextId3Tag?: PlaintextId3Tag): Promise<PlaintextId3Tag>;
    /**
     * @summary Delete Plain Text ID3 Tag of a Progressive TS muxing
     * @param {string} encodingId ID of the Encoding.
     * @param {string} muxingId ID of the Progressive TS muxing
     * @param {string} id3TagId ID of the Plain Text ID3 Tag
     * @throws {BitmovinError}
     * @memberof PlainTextApi
     */
    delete(encodingId: string, muxingId: string, id3TagId: string): Promise<BitmovinResponse>;
    /**
     * @summary Plain Text ID3 Tag Details of a Progressive TS muxing
     * @param {string} encodingId ID of the Encoding.
     * @param {string} muxingId ID of the Progressive TS muxing
     * @param {string} id3TagId ID of the Plain Text ID3 Tag
     * @throws {BitmovinError}
     * @memberof PlainTextApi
     */
    get(encodingId: string, muxingId: string, id3TagId: string): Promise<PlaintextId3Tag>;
    /**
     * @summary List Plain Text ID3 Tags of a Progressive TS muxing
     * @param {string} encodingId ID of the Encoding.
     * @param {string} muxingId ID of the Progressive TS muxing
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof PlainTextApi
     */
    list(encodingId: string, muxingId: string, queryParameters?: PlaintextId3TagListQueryParams | ((q: PlaintextId3TagListQueryParamsBuilder) => PlaintextId3TagListQueryParamsBuilder)): Promise<PaginationResponse<PlaintextId3Tag>>;
}