@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
50 lines (49 loc) • 2.23 kB
TypeScript
import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import ChunkedTextMuxing from '../../../../models/ChunkedTextMuxing';
import PaginationResponse from '../../../../models/PaginationResponse';
import { ChunkedTextMuxingListQueryParams, ChunkedTextMuxingListQueryParamsBuilder } from './ChunkedTextMuxingListQueryParams';
/**
* ChunkedTextApi - object-oriented interface
* @export
* @class ChunkedTextApi
* @extends {BaseAPI}
*/
export default class ChunkedTextApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add Chunked Text muxing
* @param {string} encodingId Id of the encoding.
* @param {ChunkedTextMuxing} chunkedTextMuxing The Chunked Text muxing to be created
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
create(encodingId: string, chunkedTextMuxing?: ChunkedTextMuxing): Promise<ChunkedTextMuxing>;
/**
* @summary Delete Chunked Text muxing
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the Chunked Text muxing
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
delete(encodingId: string, muxingId: string): Promise<BitmovinResponse>;
/**
* @summary Chunked Text muxing details
* @param {string} encodingId Id of the encoding.
* @param {string} muxingId Id of the Chunked Text muxing
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
get(encodingId: string, muxingId: string): Promise<ChunkedTextMuxing>;
/**
* @summary List Chunked Text muxings
* @param {string} encodingId Id of the encoding.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
list(encodingId: string, queryParameters?: ChunkedTextMuxingListQueryParams | ((q: ChunkedTextMuxingListQueryParamsBuilder) => ChunkedTextMuxingListQueryParamsBuilder)): Promise<PaginationResponse<ChunkedTextMuxing>>;
}